asp.net core学习——core webapi中配置并使用swagger

一、什么是swagger

swagger是一个用于生成、描述和调用RESTful接口的Web服务。通俗来讲就是将项目中所有(想要暴露的接口)接口展现在页面上，并可以进行接口调用和测试的服务。

二、安装swagger

1. 首先我们创建一个.net core webapi的项目
2. 然后进入工具–NuGet包管理器–程序包管理器控制台 中输入

PM> Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4

安装swagger

三、swagger的配置

1. 在Startup.cs文件中的ConfigureServices方法中注册swagger服务
   

// 1.注册swagger服务
services.AddSwaggerGen(m => {
   m.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo
   {
       Title = "test1",Version="v1"
   });
});

2. 在Configure方法(中间件)中使用swagger服务
   

// 2.在中间件中使用swagger服务
app.UseSwagger();
app.UseSwaggerUI(m => {
    // json的地址
    m.SwaggerEndpoint("/swagger/v1/swagger.json", "webapitest");
});

四、swagger的使用

配置完成后，启动项目，在地址栏后输入/swagger/index.html即可使用swagger查看对应接口

扩展：将swagger设置成启动页
在Properties/launchSettings.json文件中修改launchUrl的值为swagger/index.html

运行项目可以发现swagger被设置成了启动页面

喜欢的朋友可以点赞加收藏哦，谢谢！