(轉)WebApi自動產生線上文檔Swashbuckle

標籤：turn   div   system   word   swa   XML   using   webapi   dex   

原文地址：http://www.cnblogs.com/Arrays/p/5146194.html?utm_source=tuicool&utm_medium=referral

　　

1.前言1.1 SwaggerUI

SwaggerUI 是一個簡單的Restful API 測試和文檔工具。簡單、漂亮、易用（官方demo）。通過讀取JSON 配置顯示API. 項目本身僅僅也只依賴一些 html,css.js靜態檔案. 你可以幾乎放在任何Web容器上使用。

1.2 Swashbuckle

Swashbuckle 是.NET類庫,可以將WebAPI所有開放的控制器方法產生對應SwaggerUI的JSON配置。再通過SwaggerUI 顯示出來。類庫中已經包含SwaggerUI 。所以不需要額外安裝。

2.版本和資源

你可以通過下列串連擷取相關說明。

Swashbuckle 項目地址：
https://github.com/domaindrivendev/Swashbuckle
swagger-ui 項目地址：
https://github.com/swagger-api/swagger-ui
swagger-ui 官網地址：
http://swagger.io/swagger-ui/

3.快速開始

• WebAPI 安裝 Swashbuckle

  Install-Package Swashbuckle

• 瀏覽器訪問

  http://<yourhostname>.com/swagger/ui/index

• 如果不出意外則顯示
  

  4.代碼注釋產生文檔說明。

  Swashbuckle 是通過產生的XML檔案來讀取注釋的，產生 SwaggerUI，JSON 配置中的說明的。
  安裝時會在項目目錄 App_Start 檔案夾下產生一個 SwaggerConfig.cs 設定檔，用於配置 SwaggerUI 相關展示行為的。

將設定檔第99行,注釋去掉，並修改為

c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));

並在當前類中添加如下代碼

/// <summary>/// </summary>/// <param name="name"></param>/// <returns></returns>protected static string GetXmlCommentsPath(string name){     return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);}

緊接著你在此Web項目屬性選型，產生選卡中 選擇 “XML 文檔檔案”

開啟控制 "ValuesController" 添加註釋

using System;using System.Collections.Generic;using System.Linq;using System.Net;using System.Net.Http;using System.Web.Http;using ClassLibrary1;namespace WebApplication1.Controllers{    [Authorize]    public class ValuesController : ApiController    {        //some code.....                /// <summary>        /// 根據ID擷取一個值        /// </summary>        /// <param name="id">值的ID</param>        /// <remarks>當前方法根據ID擷取一個值</remarks>        /// <returns>返回</returns>        public string Get(int id)        {            return "value";        }                // some code ....    }}

儲存重寫產生.

(轉)WebApi自動產生線上文檔Swashbuckle