2015-02-07 17 views
10

Tôi hiện đang kiểm tra asp.net vnext MVC6 trong Visual Studio 2015 Preview. Tôi khá mới với asp.net nói chung, nhưng trong công ty của tôi, chúng tôi sẽ hướng tới việc tạo api trên web bằng cách sử dụng asp.net để truy cập dữ liệu trên máy chủ của chúng tôi (hiện tại chúng tôi chỉ hỗ trợ giao tiếp wcf với ứng dụng Silverlight của riêng mình). Đây là lý do tôi kiểm tra các chức năng mới của MVC 6 để đánh giá liệu chúng ta có nên đợi trước khi bắt đầu phát triển và sử dụng MVC 6 khi nó được phát hành hoặc bắt đầu phát triển ngay bây giờ và tạo một dự án Web API 2.HelpPage cho ASP.NET vNext MVC 6 Web Api

Dù sao, tôi đang xem xét tự động tạo tài liệu cho api web, đã được tích hợp vào mẫu Visual Studio cho dự án WebApi 2 bằng cách sử dụng Microsoft.AspNet.WebApi.HelpPage.

Bây giờ cho câu hỏi của tôi, có điều gì đó tương tự như thế này cho MVC 6 không? Tôi có thể nhập cùng một gói trong project.json của tôi trong dự án ASP.NET vNext/MVC6 (bất kể bạn muốn gọi nó) nhưng tôi không thể làm app.UseHelpPage(); trong tệp Startup.cs của mình.

Tôi cho rằng điều này chưa được tích hợp trong bản phát hành hiện tại. Nếu không, có bất kỳ điều gì được biết về sự tích hợp của tính năng này một khi ASP.NET vNext cuối cùng đã truy cập vào các kệ không?

Trả lời

4

Có thể tính năng này chưa có trong MVC 6, nhưng bạn có thể dùng thử Swagger. Swagger về cơ bản là một khuôn khổ để mô tả, tiêu thụ và hiển thị các API RESTful. Điều thú vị về Swashbuckle là nó không phụ thuộc vào ASP.NET MVC, vì vậy không cần phải bao gồm bất kỳ gói MVC Nuget nào để kích hoạt tài liệu API, cũng như Swashbuckle chứa phiên bản nhúng của swgagger-ui sẽ tự động phục vụ lên một lần Swashbuckle được cài đặt.

Nguồn: http://bitoftech.net/2014/08/25/asp-net-web-api-documentation-using-swagger/

+0

Xin lưu ý, tôi sẽ ghi nhớ điều này! Như nó đứng bây giờ mặc dù, nó cũng không làm việc với MVC 6. Tôi nghĩ rằng điều này đã làm vì và MVC 6 dự án là một .kproj thay vì một .csproj, gói nuget cho Swashbuckle cho một lỗi khi cài đặt. – Maarten

+0

Có một cách để làm việc này trong ASP.NET v6: http://devmeetsbi.ghost.io/help-and-test-page-for-asp-net-web-api-asp-net-5-and -mvc-6/ –

+0

Nếu API của bạn không yên tĩnh, thì điều này không hoạt động tốt. Tôi sẽ không nói đây là một câu trả lời hợp lệ vì nó chỉ một phần sẽ giúp bạn. Khi bạn sử dụng lệnh tùy chỉnh hoặc mô hình/hành động ràng buộc, hoặc nếu bạn đang tạo không phải là một REST nhưng một RPC giống như dựa trên API này sẽ không hoạt động như Swagger là rất có ý kiến. –

Các vấn đề liên quan