C# 接口生成工具Swagger用法

1，新建一個WebApi項目

 

 2，項目打開之后，引用--》右鍵--》管理NuGet程序包

 

 

3，按賬好之后，右鍵項目--》屬性--》生成  輸出勾選：XML文檔文件，如果沒有自動填充好路徑，需要自己填寫一下，文件名可以自己取

 

 4，打開App_Start文件夾下的SwaggerConfig.cs文件，新增一個如下方法：

 

 5，搜索GetXmlCommentsPath，下面能搜到已經注釋了，自己把注釋放開，要是沒搜到，就自己手動寫一下c.IncludeXmlComments(GetXmlCommentsPath());注意要寫在register方法里面

 

 6，打開valuescontroller，自己寫一些注釋

 

 7，運行項目，在根路徑后面直接加swagger，就會自動跳轉到文檔，如：http://localhost:8970/swagger，能看到我們寫的一些注釋

 

 8，在實際應用中，完全使用webapi的restful風格的api設計是比較少見的，請求方式一般也只使用get請求和post請求，所以我們做一些修改，使用的是類似restful風格的api設計，修改一下webapi的路由配置

 

 9，在Controllers中添加一個TestController.cs

using  System;

using  System.Collections.Generic;

using  System.Linq;

using  System.Net.Http;

using  System.Web;

using  System.Web.Http;

 

namespace  接口生成工具Swagger.Controllers

{

     public  class  TestController:ApiController

     {

         /// <summary>

         /// get列表

         /// </summary>

         /// <returns></returns>

         public  IEnumerable< string > Get()

         {

             return  new  string [] {  "value1" ,  "value2"  };

         }

 

         /// <summary>

         /// get請求

         /// </summary>

         /// <param name="id"></param>

         /// <returns></returns>

         public  string  Get( int  id)

         {

             return  "value" ;

         }

 

         /// <summary>

         /// post請求

         /// </summary>

         /// <param name="token"></param>

         /// <param name="model"></param>

         /// <returns></returns>

         //public HttpResponseMessage Post(string token, [FromBody]UserModel model)

         //{

         //    CookieHelper.SetUserCookie(model);

         //    string strResult = "{\"UserName\": \"" + model.UserName + "\", \"Pwd\": \"" + model.Pwd + "\"}";

         //    return new HttpResponseMessage(System.Net.HttpStatusCode.OK)

         //    {

         //        Content = new StringContent(strResult, Encoding.UTF8, "text/json")

         //    };

         //}

     }

}

　　10,運行 輸入http://localhost:64956/api/Test/Get