Asp.Net Core使用swagger生成api文档的完整步骤
前言
.NetCore中有两个集成NSwag的包，分别为Swashbuckle和NSwag。两者的配置大同小异。这里以NSwag为例。
一、前期准备
1、初始化asp.netcore测试项目
新建asp.netcore项目，此处略过；
新建apicontroller，并编写测试代码；
[Route("api/[controller]")]
[ApiController]
publicclassUserApiController:ControllerBase
{
///
///获取用户信息，根据用户id
///
///用户id
///
///添加用户
///
///用户信息
///
publicclassUser
{
///
///用户id
///
publicintId{get;set;}
///
///用户姓名
///
publicstringName{get;set;}
}
2、使用nuget安装NSwag.AspNetCore
方式一：通过vs图形界面安装；
方式二：通过nuget命令安装：
Install-PackageNSwag.AspNetCore
二、配置Swagger
1、添加并配置Swagger中间件
在应用的Startup类中的ConfigureServices方法中，注册所需的Swagger服务：
publicvoidConfigureServices(IServiceCollectionservices)
{
services.AddControllersWithViews();
//RegistertheSwaggerservices
services.AddSwaggerDocument()
}
在Startup类中的Configure方法中，启用中间件为生成的Swagger规范和SwaggerUI提供服务：
publicvoidConfigure(IApplicationBuilderapp)
{
app.UseStaticFiles();
//RegistertheSwaggergeneratorandtheSwaggerUImiddlewares
app.UseOpenApi();
app.UseSwaggerUi3();
app.UseMvc();
}
启动应用。转到：
http://localhost:/swagger，以查看SwaggerUI。
http://localhost:/swagger/v1/swagger.json，以查看Swagger规范。
2、自定义API文档
API信息和说明
在Startup.ConfigureServices方法中，传递给AddSwaggerDocument方法的配置操作会添加诸如作者、许可证和说明的信息：
publicvoidConfigureServices(IServiceCollectionservices)
{
//services.AddControllers();
services.AddControllersWithViews();
services.AddSwaggerDocument(config=>
{
config.PostProcess=document=>
{
document.Info.Version="v1";
document.Info.Title="UserManageAppAPI";
document.Info.Description="AsimpleASP.NETCorewebAPI";
document.Info.TermsOfService="None";
document.Info.Contact=newNSwag.OpenApiContact
{
Name="张三",
Email=string.Empty,
Url="https://example.com"
};
document.Info.License=newNSwag.OpenApiLicense
{
Name="UseunderLICX",
Url="https://example.com/license"
};
};
});
}
SwaggerUI显示版本的信息：
XML注释
若要启用XML注释，请执行以下步骤：
以windows先使用vs为例：
- 在“解决方案资源管理器”中右键单击该项目，然后选择“编辑.csproj”。
- 手动将突出显示的行添加到.csproj文件：
三、参考
https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-3.0&tabs=visual-studio
*以上讲解知识入门级的，能大体使用起来，能满足一般性需求；
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对毛票票的支持。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。