元哥的筆記

 

這篇是專門記錄怎麼引入NSwag，來產生API文件

建立一個ASP.net Core API的專案，安裝NSwag.AspNetCore相關套件

開始進行Startup.cs中間組件，調整追加說明和版號、啟用OpenAPI機制

        public void ConfigureServices(IServiceCollection services)
        {

            services.AddSwaggerDocument(setting=> 
            {
                setting.Version = "v2";
                setting.Title = "API 範例";
                setting.Description = "API文件相關系列";
            });
            services.AddControllers();
        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
            //調用OpenAPI相關設定
            app.UseOpenApi();    //新增swagger 產生api文件（預設路由文件 /swagger/v1/swagger.json）
            app.UseSwaggerUi3(); //新增Swagger UI到請求管道中(預設路由: /swagger).
        }

​

程式啟動會有兩個部分

• http://localhost:/swagger，專門查詢 Swagger UI。
• http://localhost:/swagger/v1/swagger.json，查詢 Swagger 規格，透過NSwag產生出來的規格文件。

 

待補

 

元哥的筆記