欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

.NetCore中使用Swagger文档自动生成

程序员文章站 2024-01-27 14:13:40
...

 

1、创建一个.NetCore WebApi项目

.NetCore中使用Swagger文档自动生成

 

2、使用Nuget安装Swagger,安装的命令是:

Install-Package Swashbuckle.AspNetCore -Pre

.NetCore中使用Swagger文档自动生成

 

3、安装完Swagger插件之后,在Startup.cs文件中的ConfigureServices方法和Configure方法注册并使用Swagger服务。

在ConfigureServices方法中添加如下代码:

public void ConfigureServices(IServiceCollection services)
        {
            //注册Swagger
            services.AddSwaggerGen(c =>
            {
                //V1:后端版本
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "Gs.Swagger", //项目名称 
                    Version = "v1"  //版本 和后端版本没有关系
                });
            });

            services.AddControllers();
        }

.NetCore中使用Swagger文档自动生成

 

在Configure方法中添加如下代码:

//注册好之后,接下来引用Swagger服务
app.UseSwagger();
app.UseSwaggerUI(c => //UI界面
{
    //参数1:写上动态生成的json信息;其中的版本和上面SwaggerDoc中的版本一致
    //参数2:文档名称
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Gs.Swagger");
});

.NetCore中使用Swagger文档自动生成

4、到目前为止,项目中已经安装好了Swagger,最后更改Properties下的launchSettings.json,设置Swagger文档为起始页

.NetCore中使用Swagger文档自动生成

5、运行项目,就可以看到项目的接口文档了

.NetCore中使用Swagger文档自动生成

 

 

 

相关标签: .NetCore Swagger