Trang Trợ giúp về WebApi Mô tả

Question

Phần nào mô tả phương thức của Webapi trên trang trợ giúp và đoạn giới thiệu?

Answer 1

Theo điều này article bạn có thể sử dụng nhận xét tài liệu XML để tạo tài liệu. Để bật tính năng này, hãy mở tệp Vùng/HelpPage/App_Start/HelpPageConfig.cs và bỏ ghi chú dòng sau:

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml"))); 

Bây giờ bật tài liệu XML. Trong Solution Explorer, nhấn chuột phải vào dự án và chọn Properties. Chọn trang Xây dựng.

Trong phần Đầu ra, hãy kiểm tra tệp tài liệu XML. Trong hộp chỉnh sửa, nhập “App_Data/XmlDocument.xml”.

Thêm một số nhận xét tài liệu vào các phương pháp điều khiển. Ví dụ:

/// <summary> 
/// Gets some very important data from the server. 
/// </summary> 
public IEnumerable<string> Get() 
{ 
    return new string[] { "value1", "value2" }; 
} 

/// <summary> 
/// Looks up some data by ID. 
/// </summary> 
/// <param name="id">The ID of the data.</param> 
public string Get(int id) 
{ 
    return "value"; 
} 

Answer 2

Để xem mô tả bạn cần phải làm theo điều này:

1. Mỗi hành động trong bộ điều khiển khách hàng của bạn phải có một tài liệu hướng dẫn XML
2. mở các tính chất của dự án mà chứa bộ điều khiển của bạn và bật XML documenation như sau:
3. Trong Đăng ký phương pháp HelpPageConfig lớp (khu vực/helppage/App_Start/HelpPageConfig.cs) bỏ ghi chú dòng 19 và đừng quên để thay đổi đường dẫn tập tin như thế này:

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/MvcApplication4.XML")));

Tất cả những gì bạn phải làm. Điều cuối cùng là bao gồm tệp được tạo trong App_Data trong dự án của bạn để tệp sẽ được triển khai trong quá trình sản xuất.