.Net Core 基础学习笔记(一) Swagger配置使用

1. 安装swagger 包

 

 

2.Startup中 ConfigureServices 方法中添加代码

services.AddSwaggerGen(c =>
{
c.SwaggerDoc("service1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "service1", Version = "1.0" });
});

　　

3.Startup中 Configure 方法中添加代码

if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}

// app.UseHttpsRedirection();

app.UseRouting();
app.UseSwagger(c=> {
c.RouteTemplate = "{documentName}/swagger.json";
});

app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/service1/swagger.json", "Service1 version 1.0");
});

app.UseAuthorization();

app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});

4.使用自定义端口，在Program中添加UseUrls()

 public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder.UseStartup<Startup>();
                    webBuilder.UseUrls("http://0.0.0.0:8001");
                });

5.踩坑点记录

(1) 使用http访问需要注释掉app.UseHttpsRedirection(); 改代码会将http 重定向至 https，导致项目无法访问

(2) docker 部署时 需要使用 0.0.0.0:端口，否则无法正常映射，外网无法访问