Tài liệu Trang trợ giúp về ASP.NET Web API bằng cách sử dụng các bình luận Xml trên bộ điều khiển

Question

Tôi đã cài đặt gói ASP.NET Web API Help Page và muốn sử dụng nó để tạo tài liệu cho các hành động điều khiển API của tôi bằng cách sử dụng các nhận xét Xml đã có trên chúng.

Tôi đã xem qua số article on Yao's MSDN blog nơi ông thảo luận về cách tài liệu có thể được tạo dựa trên các nhận xét XML.

Tuy nhiên, trong phương thức Đăng ký HelpPageConfig, phương pháp SetDocumentationProvider dự kiến ​​một phiên bản XmlDocumentationProvider được tạo bằng đường dẫn vật lý vào tệp tài liệu Xml.

Có cách nào khác để thực hiện việc này không? Tôi không rõ tại sao tôi cần trỏ đến tệp tài liệu Xml.

Cảm ơn

Answer 1

Các XmlDocumentationProvider đang tìm kiếm các tập tin xml (có ý kiến ​​mã xml của bạn) mà được tạo ra khi bạn biên dịch dự án của bạn. Bạn có thể bật tính năng này bằng cách chuyển đến thuộc tính dự án của bạn -> Xây dựng -> Đầu ra. Ở đây chọn hộp kiểm cho tệp tài liệu XML.

Answer 2

Nếu bạn vẫn gặp sự cố thì hãy xem các bước bên dưới.

Bước 1 - Thêm bình luận về mức độ điều khiển

// GET api/documentation 
/// <summary> 
/// This is how we create a documentation 
/// </summary> 
/// <returns></returns> 
public IEnumerable<string> Get() 

Bước 2 - Xây dựng tài sản trang Project Properties và thiết lập đầu ra xml cho tài liệu

Bước 3 - Cấu hình HelpPage

Để thiết lập HelpPageConfig để sử dụng tệp xml tài liệu của chúng tôi, hãy truy cập ~\Areas\HelpPage\HelpPageConfig.cs.

Theo mặc định, câu lệnh config.SetDocumentationProvider được nhận xét. Sử dụng tuyên bố đó, và chỉ vị trí của DocumentationProvider đến file xml của chúng tôi:

public static void Register(HttpConfiguration config) 
{ 
    // Uncomment the following to use the documentation from XML documentation file. 
    config.SetDocumentationProvider(
      new XmlDocumentationProvider(
       HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml"))); 
} 

EDIT:

Vị trí của HelpPageConfig trong một Web API 2.2 dự án mới được tạo ra trong VS2013 là ~\Areas\HelpPage\App_Start\HelpPageConfig.cs

Answer 3

Tôi biết rằng câu hỏi này được trả lời, nhưng trong trường hợp nó giúp ai đó Tôi đã tìm thấy trang này vì tìm kiếm giải pháp cho tài liệu cho IHttpActionResult

How to add IHttpActionResult into documentation