swagger는 여러 플랫폼을 API문서화 자동화를 지원하는 툴입니다.
swagger설치
Install-Package Swashbuckle.AspNetCore
.net 에서 swagger을 사용하기위해서는 이 한줄이면 충분합니다.
Application 셋팅
Expand source
namespace accountapi { public class Startup { // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices( IServiceCollection services ) { services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_1); // Register the Swagger generator, defining 1 or more Swagger documents services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" }); var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); c.IncludeXmlComments(xmlPath); }); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure( IApplicationBuilder app, IHostingEnvironment env ) { app.UseStaticFiles(); if ( env.IsDevelopment() ) { using (var serviceScope = app.ApplicationServices.GetService<IServiceScopeFactory>().CreateScope()) { } app.UseDeveloperExceptionPage(); } // Enable middleware to serve generated Swagger as a JSON endpoint. app.UseSwagger(); // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), // specifying the Swagger JSON endpoint. app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); }); app.UseSession(); app.UseMvc(); } } }