问题:
不同软件/程序在网络中互相传递信息不统一。
交互不便。
REST API
作用:
RESTful API就是一套协议,用来规范多种形式的前端和同一个后台的交互方式。
原理:
组成/流程/规范:
遵守OpenAPI规范
软件的REST API文档
问题:
在API的迭代开发过程中,文档更新工作容易遗漏。
swagger框架
功能:
生成遵守OpenAPI规范的、JSON或YAML格式的RESTful API文档。
实现:
读取嵌入到源代码中的api文档,生成api文档。
swagger规范:
作用:
编辑器 解析 yaml/json字符串
(使用此规范的) (遵守此规范的)
借助swagger-py-codegen框架
由 生成 web framework 的结构代码
由注解代码自动生成rest api文档。
应用层协议:DNS/FTP/SMTP/HTTP等等
REST和Http关系:
REST is just a set of rules about how to use HTTP
https://*.com/questions/2190836/what-is-the-difference-between-http-and-rest
RESTfull api生态:
REST api描述规范:OpenAPI规范。
围绕OpenAPI规范构建的开源工具:Swagger。
https://www.breakyizhan.com/swagger/2806.html
API文档管理工具:Swagger类似
https://www.cnblogs.com/softidea/p/5728952.html
https://hacpai.com/article/1519833837647
https://zhuanlan.zhihu.com/p/45591474
与tornado相关的swagger工具
https://github.com/rduldulao/tornado-swirl
(要求python3.6以上、tornado5.1.1以上)
https://github.com/SerenaFeng/tornado-swagger