iT邦幫忙

2019 iT 邦幫忙鐵人賽

0

後端寫了很多API,前端人員可能不知道或不清楚哪個API已經可行或是有bug待修

專案上就需要統一產生一個漂亮又可以呼叫API的文件
=> 那就是要Swagger

安裝

VS 2017開啟專案下
進入nuget套件管理員,搜尋Swashbuckle.AspNetCore

或是開啟Terminal cd進入我們的專案下

dotnet add package Swashbuckle.AspNetCore

設定

安裝好以後進入Startup.cs去做啟用

public void ConfigureServices(IServiceCollection services)
        {
    using Swashbuckle.AspNetCore.Swagger;    
    //註冊這個Swagger產生器藉以取得API規格,並產生SwaggerDocument物件
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new Info { Title = "Tri API", Version = "v1" });
    });
    }
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
          //提供SwaggerDocument物件
          app.UseSwagger();
          //變成漂亮的UI
          app.UseSwaggerUI(c =>
         {
          c.SwaggerEndpoint("/swagger/v1/swagger.json", "Tri API V1");
         });

啟用

F5將專案Run起來,接著進入https://localhost:5001/swagger

接著就能看到精美的swagger畫面
https://ithelp.ithome.com.tw/upload/images/20181110/201056842duWvhXrnl.png

部署

https://ithelp.ithome.com.tw/upload/images/20181110/20105684bK9wcSq2IU.jpg


上一篇
Day 0 回歸初衷-鐵人賽結語
系列文
三十天利用Angular與.net Core開發實戰一波32

尚未有邦友留言

立即登入留言