REST api文檔管理工具

問題:
不一樣軟件/程序在網絡中互相傳遞信息不統一。
交互不便。

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://stackoverflow.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