[Python知识库] python整合swagger基于flask

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> Python知识库 -> python整合swagger基于flask -> 正文阅读

[Python知识库]python整合swagger基于flask

参考博客： python 如何使用swagger

Swagger Editor案例：Swagger Editor

Swagger官网

步骤

1. 编写yml

获取数据列表
This is the language awesomeness API
Call this api passing a language name and get back its features
    ---
    tags:
      - xxx API
    description: ""
    parameters:
      - name: page_size
        in: query
        type: integer
        description:  size of each data page
        required: false
      - name: page_num
        in: query
        type: integer
        description: page of data list
        required: false
      - name: status_s
        in: query
        type: string
        description: data status
        required: false
    responses:
      500:
        description: Error get data list failed!
      200:
        description: The data list
        content:
            application/json:
              examples: # Multiple examples
                200: #
                  value: {
                    "code": 200,
                    "total": 2,
                    "page_num": 1,
                    "page_size": 20,
                    "data": [{xxx
                    },{
                    xxx
                    }]
                  }
                  summary: "相应Collection定义的JSON格式数据记录"  # Optional description

2. 使用@swag_from 装饰器

from flasgger import Swagger, swag_from

在这里插入图片描述

3. 运行main.py测试接口

在这里插入图片描述

4. post方法测试

yml文件编写：

保存数据
This is the language awesomeness API
Call this api passing a language name and get back its features
---
tags:
  - xxx API
description: 保存数据
parameters:
  - name: body
    in: body
    description:  save obj and its obj list
    required: true
    schema:
        $ref: "#/definitions/Project"
responses:
  400:
    description: Invalid param value!
  20000:
    description:  save success
    content:
      application/json:
        examples: # Multiple examples
          20000: #
            value: {
              "code": 200,
              "data": "",
              "error_msg": "保存成功"
            }