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

栏目: CSS · 发布时间: 7年前

内容简介:在大部分的团队开发环境里,客户端和服务器端的交流需要通过网络请求接口来实现,而开发时,接口文档更是避不开的一个重要环节,而swagger 官方也实现了一套展示接口的界面

前言

在大部分的团队开发环境里,客户端和服务器端的交流需要通过网络请求接口来实现,而开发时,接口文档更是避不开的一个重要环节,而 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: 中文文档


以上所述就是小编给大家介绍的《给 Swagger-Bootstrap-UI 加一个强力功能》,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对 码农网 的支持!

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

软件随想录

软件随想录

Joel Spolsky / 阮一峰 / 人民邮电出版社 / 2009 / 49.00元

《软件随想录:程序员部落酋长Joel谈软件》是一部关于软件技术、人才、创业和企业管理的随想文集,作者以诙谐幽默的笔触将自己在软件行业的亲身感悟娓娓道来,观点新颖独特,内容简洁实用。全书分为 36讲,每一讲都是一个独立的专题。 《软件随想录:程序员部落酋长Joel谈软件》从不同侧面满足了软件开发人员、设计人员、管理人员及从事软件相关工作的人员的学习与工作需要。一起来看看 《软件随想录》 这本书的介绍吧!

RGB转16进制工具
RGB转16进制工具

RGB HEX 互转工具

XML、JSON 在线转换
XML、JSON 在线转换

在线XML、JSON转换工具

RGB HSV 转换
RGB HSV 转换

RGB HSV 互转工具