Flask Swagger | Olimi’s Blog

Swagger是一个开源的API文档工具，它允许开发人员描述、编写和测试API。它具有易用性强、描述格式简单、支持多语言等特点，被广泛应用于互联网公司和开发者社区。

使用Swagger，开发人员可以定义API的路径、请求方法、参数、返回值等细节信息，并通过Swagger UI进行API测试和文档展示。开发人员可以编写各种类型的文档描述，包括RAML和OpenAPI规范。

特性：

Flasgger是一个Flask扩展，可从您的API中所有已注册的Flask视图中提取OpenAPI-Specification（以下简称"spec"）。

Flasgger还集成 SwaggerUI，因此您可以访问http://localhost:5000/apidocs并可视化并与您的API资源进行交互。

Flasgger还使用与可以验证以POST，PUT，PATCH形式接收的数据是否与YAML，Python字典，Marshmallow Schema所定义的spec一致。

Flasgger可以使用简单的函数视图或方法视图（使用docstring作为规范），或使用@swag_from装饰器从YAML或dict获取spec，还提供可以使用SwaggerView调用Marshmallow Schemas作为spec。

Flasgger还支持将Marshmallow APISpec作为规范的spec模板，如果您使用的是Marshmallow的APISPec，请查看apispec示例。

以下是官网的示例。

基础使用示例

相应的解释：

validation

以及相应的yml.

就会根据这里参数的要求，检查age是整数、username是字符串。如果输入参数不匹配，就会出现400错误。

效果：

根据flask-restplus发展而来，前者已经不维护无法使用。

效果：

类似于Marshmallow APISpec 的风格。定义一些Schema叫做Model，和OpenAPI描述的definition类似。然后定义资源的概念，围绕资源添加CURD的接口，然后自动生成相应的Restful API文档。