NSwag Studio 產生API的Client介接程式碼

4月 10, 2020

前言

一直以來在寫Web API時，給同事參考都是透過Swagger產生的說明文件。如下圖使用Swashbuckle 套件產生。

專案環境

.Net Framework 4.8
ASP.NET Web API 2
ASP.NET MVC

跟API 取資料，作展示。

問題

同事詢問是否可以直接提供介接類別，讓他直接可以使用。例如:Google API SDK。這...若要手刻的話，可能會累屬偶，幸好科技發達，關於這方面，早已有相關的解決方法。

如何使用

1. Web API 安裝NSwag

安裝Nuget package

NSwag.AspNet.Owin
Microsoft.AspNet.WebApi.Owin
Microsoft.Owin.Host.SystemWeb

ps: 關於為什麼不用Swashbuckle，請參考此篇。

在Web API專案新增Startup.cs

[assembly: OwinStartup(typeof(NSwagLab.Startup))]

namespace NSwagLab

{

    public class Startup

    {

        public void Configuration(IAppBuilder app)

        {

            var config = new HttpConfiguration();

            app.UseSwaggerUi3(typeof(Startup).Assembly, settings =>

            {

                //針對RPC-Style WebAPI，指定路由包含Action名稱

                settings.GeneratorSettings.DefaultUrlTemplate =

                    "api/{controller}/{action}/{id?}";

                //可加入客製化調整邏輯

                settings.PostProcess = document =>

                {

                    document.Info.Title = "WebAPI 範例";

                };

            });

        }

    }

}

Web.config 新增handler

  <system.webServer>

    ...

    <handlers>

    ...

      <add name="NSwag" path="swagger" verb="*" type="System.Web.Handlers.TransferRequestHandler" preCondition="integratedMode,runtimeVersionv4.0" />

    </handlers>

  </system.webServer>