ABP(二)使用ABP实现SwaggerUI 生成动态webapi

本章节官网文档地址http://www.aspnetboilerplate.com/Pages/Documents/Swagger-UI-Integration本人只是翻译为中文,关于部分代码添加可查看官方文档。 1.什么是SwaggerUI 通过Swagger Api可以生成一个交互式的文档。通过它可以对你的接口进行调式。2.使用 SwaggerUI 需要引入包管理器在WebApi项目上右键,选择NuGet包管理器 搜索**Swashbuckle.core 然后选择安装

ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第1张图片
图片
**
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第2张图片
图片
3.新增配置代码需要引入using Swashbuckle.Application;
using System.Linq;

ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第3张图片
图片
4.然后运行项目 可以看到生成的API测试页面Test
That's all. Let's browse /swagger/ui/index:
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第4张图片
图片
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第5张图片
图片
5.让API文档显示方法注释关于Swashbuckle 的配置 请参考github地址 https://github.com/domaindrivendev/Swashbuckle
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第6张图片
图片

6.打开PhoneBook.Application类库的属性设置,然后在生成中找到XML文档文件,启用生成
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第7张图片
图片
7.添加配置代码 配置说明参考官方文档 关于路径官方文档写的是var commentsFileName = Assembly.GetExecutingAssembly().GetName().Name + ".XML";但是这样获取到的是WEB API的路径 所以此处我是写的固定地址
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第8张图片
图片
8.Application层添加注释 运行项目
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第9张图片
图片
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第10张图片
图片
9.运行效果
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第11张图片
图片
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第12张图片
图片
10.修改API访问地址目前访问地址都是swagger/ui/index查看配置方法F12
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第13张图片
图片
支持路由重定向,给个参数修改下
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第14张图片
图片
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第15张图片
图片
ABP(二)使用ABP实现SwaggerUI 生成动态webapi_第16张图片
图片

你可能感兴趣的:(ABP(二)使用ABP实现SwaggerUI 生成动态webapi)