要实现微服务框架API接口必不可少,使用Swagger工具可以更加方便的生成API框架和对应的接口文档。
- 首先,在swaggerhub.com上面注册一个账户,选免费的即可
根据示例工程,自己在编辑器中修改既可以看到API文档情况。
- 其次,如果想保存这些API文档,而可以通过设置于Github账号同步,直接同步到github账号下的指定仓库。
保存设计的API接口后,在swaggerHub网站的项目下,找到Add New Integrations,添加一个GitHub sync。保持账户登陆状态既可以生成token到swaggerhub,设置存放仓库路径即可。
- 我测试了server stub下面的nodejs-server生成类型,同步到github网站后,在客户端用git工具,打开git bash。直接运行
1 | npm start |
- 最后,如果从git上面下载到本地后。执行正确,在本机输入http://localhost:8080/docs/,可以看到下图:
PS:通过自动生成的API文档,可以通过github仓库进行保存,再通过CD工具,可以部署到docker或者远程服务器,将API文档发布出来。当然也可以直接在swaggerhub上面浏览或用第三方工具如ReDoc来直接通过GitHub的pages功能进行发布(由于pages只能发布静态网页,所以nodejs项目的执行必须通过工具先生成静态网页才可以运行,如Hexo建站原理类似)。
github上测试项目地址,https://igp-gravity.github.io/geoistapi/