OpenAPI接口规范 学习
学习资料:
GitHub 上接口规范文档:https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject
较易理解的接口规范文档:https://www.breakyizhan.com/swagger/2810.html
如何编写基于OpenAPI规范的API文档:https://legacy.gitbook.com/book/huangwenchao/swagger/details
非常好用的OpenAPI文档编写工具SWAGGERhub,在线编辑,自动mock:https://app.swaggerhub.com
在swagger上编写API文档,左边是代码区,右边是相应的UI展示。
编写完成后,将文档下载到本地。
下载OpenAPI 3 / Swagger API 模拟服务器:http://stoplight.io/platform/prism/
在cmd中进入prism所在的文件夹,用如下命令启动模拟服务器:
(其中 --cors 是用来解决跨域问题的,否则在swagger在线编辑器上无法执行)
在接口文档中加入如下语句:
便可以通过浏览器访问输出了:
不过由于prism现在只支持OpenAPI2.0 ,使用OpenAPI3.0.0会无法mock到数据。推荐使用更好用的工具SWAGGERhub!!
在线编辑,自动mock。