WebApi结合Swaggerui实现在线接口文档-创新互联

Step1 添加NuGet包 Swashbuckle

创新互联坚持“要么做到,要么别承诺”的工作理念,服务领域包括:成都网站设计、成都网站制作、外贸网站建设、企业官网、英文网站、手机端网站、网站推广等服务,满足客户于互联网时代的盐城网站设计、移动媒体设计的需求,帮助企业找到有效的互联网解决方案。努力成为您成熟可靠的网络建设合作伙伴!

WebApi结合Swagger ui 实现在线接口文档

step2 修改SwaggerConfig.cs

Swasshbuckle 安装完成之后会在App_Start下创建一个名为SwaggerConfig.cs的类,把内容替换为:

WebApi结合Swagger ui 实现在线接口文档

Step3 创建生成XML

右键你的项目→属性→生成→选中下方的 "XML文档文件" 然后保存

WebApi结合Swagger ui 实现在线接口文档

step4 启动你的项目

访问地址为:http://localhost:58192/swagger/

WebApi结合Swagger ui 实现在线接口文档

扩展:在Swagger中 实现 自定义 HTTP Header

在开发移动端 API时常常需要验证权限,验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可

首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter:

WebApi结合Swagger ui 实现在线接口文档

在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码

c.OperationFilter();

WebApi结合Swagger ui 实现在线接口文档

添加权限过滤器

WebApi结合Swagger ui 实现在线接口文档

运行 swagger

WebApi结合Swagger ui 实现在线接口文档

创新互联www.cdcxhl.cn,专业提供香港、美国云服务器,动态BGP最优骨干路由自动选择,持续稳定高效的网络助力业务部署。公司持有工信部办法的idc、isp许可证, 机房独有T级流量清洗系统配攻击溯源,准确进行流量调度,确保服务器高可用性。佳节活动现已开启,新人活动云服务器买多久送多久。


文章名称:WebApi结合Swaggerui实现在线接口文档-创新互联
本文链接:http://scyanting.com/article/ddhjgi.html