河南郑州百度网站建设,化妆品网站建设实施背景,建设银行成都开发中心网站,wordpress 仿 模板下载关注架构师高级俱乐部开启架构之路不定期福利发放哦~Leon读完需要4分钟速读仅需 2 分钟介绍一款Swagger扩展日常接口开发中都需要用到Swagger来生成接口文档并用 Swagger 自带支持的模拟请求进行测试#xff0c;但是需要支持认证或者上传文件等操作需要自行去按接口进行开发才… 关注架构师高级俱乐部开启架构之路不定期福利发放哦~Leon读完需要4分钟速读仅需 2 分钟介绍一款Swagger扩展日常接口开发中都需要用到Swagger来生成接口文档并用 Swagger 自带支持的模拟请求进行测试但是需要支持认证或者上传文件等操作需要自行去按接口进行开发才可支持现在介绍一款封装了 Swagger 的中间件来避免一些繁琐的操作即可支持常用功能1 如何使用安装 NetPro.Swagger执行以下命令或者 Nuget 包管理器中搜索安装最新版Install-Package NetPro.Swagger -Version 3.1.6
Swagger 注入public void ConfigureServices(IServiceCollection services,IConfiguration configuration)
{ services.AddNetProSwagger(configuration);
} public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{ app.UseNetProSwagger();
}
输出 XML 文档相关类库 csproj 工程文件中加入以下配置PropertyGroup Condition$(Configuration)|$(Platform)Debug|AnyCPU
DocumentationFilebin\Debug\netcoreapp3.1\程序集名称.xml/DocumentationFile /PropertyGroup
运行没有任何反应这时候需要在 appsetting.json 配置文件中加入相关配置SwaggerOption: { Enable: true,//是否开启Swagger RoutePrefix: swagger, Description: this is swagger for netcore, Title: Demo swagger, Version: first version, TermsOfService: netcore.com, Contact: { Email: swaggernetcore.com, Name: swagger, Url: swaggernetcore.com }, License: { Name: , Url: } }
再次执行dotnet run 命令运行可以看见右上角默认支持认证点击输入 jwt 即可2 支持功能2.1 暗黑主题SwaggerOption 配置节点中增加 IsDarkTheme 等于 true 即可 IsDarkTheme: true,
2.2 文件上传按钮请求参数类型为 IFormFileSwagger 会自动识别为为其添加文件按钮 /// summary/// 单文件/// /summarypublic IFormFile File { get; set; }
2.3 添加公共 Url 参数一般接口会有一些公共参数但一般接口内部不会用到例如签名参数就没必要每个请求实体都包含这些业务接口不使用的参数可以通过以下节点添加 swagger 公共参数还不污染请求实体Query: [ //swagger默认url公共参数 { Name: sign, Description: 签名 }, { Name: timestamp, Description: 客户端时间戳 } ]
2.4 添加公共头参数添加以下配置节点即可把公共参数添加进 swagger 头信息 Headers: [ //swagger默认头参数 { Name: User, Description: 用户 } ],
就是这么简单,swagger功能都通过appsetting.json配置即可。此库只是NetPro项目下的一个扩展功能其中还包括很多其他常用组件与开箱即用打包所有组件的NetPro.Web.Api组件更加方便容易的开发Api接口项目地址https://github.com/LeonKou/NetPro https://github.com/LeonKou/NetPro.Swaggergithub
