restful 接口文档_Flasgger - 为Flask快速生成Swagger文档

接手了一个用Flask写的API项目,但一看到项目里那散落着的残缺的Markdown文档,你就觉得头大。

能不能生成一个可以清晰描述接口,还能进行交互测试的文档呢?

Swagger,这个用于生成、描述、调用和可视化 RESTful 风格的 Web 服务框架,已经成为 API 文档的事实标准。

而 Flasgger,把 Swagger 带给了 Flask。

restful 接口文档_Flasgger - 为Flask快速生成Swagger文档_第1张图片

Swagger框架

简介

Flasgger,是 flasgger 组织在Github上开源的解析和渲染 SwaggerUI 的 Flask 拓展。

其提供了对于Swagger文档标准的解析和SwaggerUI的生成,支持使用YAML、Python字典和Marshmallow Schema的定义,

支持使用JSON Schema进行数据验证,支持Flask-RESTful框架的使用,对于使用Flask框架的开发者而言十分方便。

restful 接口文档_Flasgger - 为Flask快速生成Swagger文档_第2张图片

你可能感兴趣的:(restful,接口文档)