REST api文档管理工具

最新推荐文章于 2025-06-14 09:24:18 发布

转载最新推荐文章于 2025-06-14 09:24:18 发布 · 244 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/wenlin-gk/p/10493975.html

文章标签：

#json #运维 #前端 #ViewUI

本文探讨了RESTful API的设计原则及其在软件开发中的作用，强调了遵循OpenAPI规范的重要性。文章详细介绍了Swagger框架如何自动生成符合规范的API文档，简化了API的迭代开发过程，并提到了与tornado框架结合使用的swagger工具。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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