转载

给 Swagger-Bootstrap-UI 加一个强力功能

前言

在大部分的团队开发环境里,客户端和服务器端的交流需要通过网络请求接口来实现,而开发时,接口文档更是避不开的一个重要环节,而 swagger 就是为这个环节而生,可以将它是理解成一套接口描述规范。

swagger-ui

swagger 官方也实现了一套展示接口的界面 swagger-ui ,就如下图这样的:

给 Swagger-Bootstrap-UI 加一个强力功能

Swagger-Bootstrap-UI

有同事给我推荐了 Swagger-Bootstrap-UI ,这是是国内大神写的一套全新 的 swagger UI,界面更清晰友好,我很喜欢。

给 Swagger-Bootstrap-UI 加一个强力功能

apitest

我曾经写过一个 PHP 的接口开发框架 HaoAPI ,其中包含了一个接口文档的实现方案,我称之为 apitest ,那时候我还不知道 swagger,就算知道也会觉得使用过程太过繁琐,总之,我还是很满意 apitest 里所实现的功能的,其中最大的一个亮点就是:在请求的结果里可以直观得看到各字段的描述。

给 Swagger-Bootstrap-UI 加一个强力功能

锦上添花

在团队里准备推广 swagger 的时候,就有同事提出,apitest 的字段描述功能非常好用,swagger 里并不支持该功能,搜遍 google 也没看到有谁提到过类似功能,很是遗憾。

于是我就在想能否在 Swagger-Bootstrap-UI 里也实现字段描述的功能呢,经过一段时间的尝试之后,结合过去开发类似功能的经验,终于有了成果。

给 Swagger-Bootstrap-UI 加一个强力功能

后语

感谢 xiaoymin 的支持,我提交了一个 PR 之后,该功能目前已被 Swagger-Bootstrap-UI 纳入最新版本,大家可以下载最新版本进行体验。

Swagger-Bootstrap-UI: 中文文档

原文  https://wanyaxing.com/wanyaxing_com/blog/20190124201704.html
正文到此结束
Loading...