.net core创建Swagger API项目

.net core创建Swagger API项目

第一步 创建WEB API项目

1、选择ASP.NET CORE Web API 创建项目并填写名称

2、这里我选择的是.net core 3.1

第二步 创建API方法并使用swagger

1、这是项目自带的文件，我们删除重新创建自己实际需要的控制器

2、创建一个API控制器

3、新建一个api方法，把控制器上的路径补充完整，方法的请求方式根据实际业务来，这里用get请求

4、右键方案=》管理nuget包=》搜索swagger，安装下图的三个包或者直接安装Swashbuckle.AspNetCore，他包含了以下3个组件

5、在staup类添加以下代码，使用注册swagger组件

services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "ID Build API", Version = "v1" }); });//使用swagger

app.UseSwagger();//使用swagger

app.UseSwaggerUI(c => { c.SwaggerEndpoint("v1/swagger.json", "ID Build V1"); });//使用swagger交互UI模式

6、在launchSetting配置文件修改默认启动页

第三步 测试API

1、启动项目可以看到swagger页面

2、页面调用api成功

3、postman调用成功