openAPI
前言
初次接触openapi,查了些资料,仍觉得不是很理解
记录下自己的理解,不对之处,欢迎指出讨论
定义
描述http api的文档 通常是 xxx.yaml或xxx.json文件
类比通用api的说明文档
为什么用
api符合openapi规范,可使用相关工具:
文档生成工具,展示API
代码生成工具,自动生成各种编程语言的服务器端和客户端的代码
自动测试工具,测试
相关工具
swagger
openapi demo:https://editor.swagger.io/
左边是openapi文档,右边是swagger生成的ui
左边粘贴代码,右边自动生成
参考
OpenAPI Specification v3.0.3
https://editor.swagger.io/
https://spec.openapis.org/oas/v3.0.3
https://blog.csdn.net/xiaoyi52/article/details/121198620
https://wenku.baidu.com/view/bbe43cc6adaad1f34693daef5ef7ba0d4a736d0e.html