元哥的筆記

     長期以來，我在做需求分析寫API   spec文件，大部分都是用word交付給其他team的工程師

明明知道可以用API Helper或是Swagger方式去產生API相關spec，其實盡量可以透過code來產出

文件相關spec，這樣做才是最好。

Swagger工具其實擁有了文件與測試的功能，維持了程式和文檔一致性，搞不懂人類為什麼喜歡用

人工方式一直做同樣的事情...老是做這種苦差事，其實也是挺阿雜的...

首先先用Nuget方式進行

Dependencies -- > Manage Nuget Packags --> Browse --> Search "Swashbuckle.AspNetCore" --> Install

接者開始進行做一些API的相關設定

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new Info
                {
                    Version = "v0.1.0",
                    Title = "範例API",
                    Description = "API說明檔",
                    TermsOfService = "None",
                    Contact = new Swashbuckle.AspNetCore.Swagger.Contact { Name = "Sample.Core",
                        Email = "WebSite@xxx.com", Url = "https://www.dotblogs.com.tw/bda605"
                    }
                });
            });
        }

        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            //Swagger Setting
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
            });

            app.UseMvc();
        }

這樣就架設完成了

元哥的筆記