背景

利用 Swagger 官方的 Editor 和 UI 已经能够展示文档，但最后做为交付的文档，肯定是需要能直接打开的文档(e.g. html 格式)才行。所以这两天研究了之后，找到了几个解决方案

• pretty-swag
• spectacle
• bootprint-openapi
• html-inline (把 html,js,css 整合到一个 html 中)

他们都是基于 Node.js 的，所以要先安装较新版的 node.js(v10)，下面分别来介绍下怎么使用。

在下面打开的一些完整示例的时候，除 pretty-swag 外都是支持手机端的，不过在电脑上的效果最好。

背景

前两天提到项目组打算用 swagger 来做为 RESTful API 的解决方案，现在已经确定下来了。

之前看到有文章介绍 SpringBoot 中结合 Swagger 直接生成文档的方法，今天尝试了一下，入门还是比较简单的。

背景

项目组最近新开发一套 RESTful API，需要对应的 API 文档，其实之前我有用 apidoc 作为方案给大家看过。

感觉还好，也是可以直接写成注释放在代码里最后生成。但能感受到它属于轻量级的，内容相对自由，灵活度很大，但也意味着更容易犯错。

不过最后上面还是决定使用 swagger 这一套东西，所以简单的看了下，功能果然成强大，显得更 professionnal 一些。

下面就罗列下我目前掌握的一些信息，其实学习 swagger 的过程就是学习 RESTful API 的过程。