失眠网 > 使用Swagger服务搭建.Net Core API

使用Swagger服务搭建.Net Core API

时间：2022-04-22 21:53:52

创建.Net Core API

新建项目。文件——新建——项目

选择应用程序模板。

设置存放路径，命名方案名称。

创建API。

搭建成功。

使用Swagger服务

添加引用

右键依赖项

搜索服务并安装。安装好之后，在NuGet下会新增该包。

在Startup.cs下的ConfigureServices方法中添加服务。

public void ConfigureServices(IServiceCollection services){services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);// Register the Swagger generator, defining 1 or more Swagger documentsservices.AddSwaggerGen(c =>{c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";var xmlPath = bine(AppContext.BaseDirectory, xmlFile);// c.IncludeXmlComments(xmlPath); });}

在Startup.cs类下的Configure方法中使用服务。

public void Configure(IApplicationBuilder app, IHostingEnvironment env){if (env.IsDevelopment()){app.UseDeveloperExceptionPage();}else{// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.app.UseHsts();}app.UseSwagger();//启用中间件服务对swagger-ui，指定Swagger JSON终结点app.UseSwaggerUI(c =>{c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");});app.UseHttpsRedirection();app.UseMvc();}