Swagger简介,轻松构造restful api的文档

Posted 沧海一粟,何以久远

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Swagger简介,轻松构造restful api的文档相关的知识,希望对你有一定的参考价值。

 

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单

 

介绍一款阿里使用的API文档工具,叫rap,这玩意儿用一句话就能概括:解放生产力,代替手写API的web工具。 

 

 

python结合swagger的插件很多:

1、flask-restful-swagger:https://github.com/rantav/flask-restful-swagger;http://flask-restful-swagger.readthedocs.io/en/latest/articles/README.html

2、使用swagger 生成 Flask RESTful API

3、flasgger:https://www.ctolib.com/rochacbruno-flasgger.html;https://github.com/rochacbruno/flasgger;

4、flask-swagger:https://github.com/gangverk/flask-swagger

5、pyswagger:https://github.com/pyopenapi/pyswagger

6、等等,用到的时候再选型吧

 

 

https://www.cnblogs.com/tianshifu/p/7156563.html

https://blog.csdn.net/wangnan9279/article/details/44541665

https://blog.csdn.net/i6448038/article/details/77622977

http://michal.karzynski.pl/blog/2016/06/19/building-beautiful-restful-apis-using-flask-swagger-ui-flask-restplus/

以上是关于Swagger简介,轻松构造restful api的文档的主要内容,如果未能解决你的问题,请参考以下文章

Spring集成Swagger2,提供RestFul API

Spring Boot中使用Swagger2构建RESTful APIS(含源码)

spring boot 1.5.4 集成Swagger2构建Restful API(十八)

Swagger简介及在SpringBoot项目中的使用

django-rest-swagger对API接口注释

Spring Boot整合Swagger2构建RESTful API