在flask中使用swagger(flasgger使用方法及效果展示)

用户1214487

发布于 2019-05-25 18:42:42

6.5K0

发布于 2019-05-25 18:42:42

文章被收录于专栏：PythonPython

一. 部分代码及效果

from flask import Flask
from flasgger import Swagger

import config

app = Flask(__name__)
app.config.from_object(config)

swagger_config = Swagger.DEFAULT_CONFIG
swagger_config['title'] = config.SWAGGER_TITLE    # 配置大标题
swagger_config['description'] = config.SWAGGER_DESC    # 配置公共描述内容
swagger_config['host'] = config.SWAGGER_HOST    # 请求域名

# swagger_config['swagger_ui_bundle_js'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js'
# swagger_config['swagger_ui_standalone_preset_js'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui-standalone-preset.js'
# swagger_config['jquery_js'] = '//unpkg.com/jquery@2.2.4/dist/jquery.min.js'
# swagger_config['swagger_ui_css'] = '//unpkg.com/swagger-ui-dist@3/swagger-ui.css'
Swagger(app, config=swagger_config)

@blueprint.route('/register/', methods=['POST'])
def register():
    """
    用户注册
    ---
    tags:
      - 用户相关接口
    description:
        用户注册接口，json格式
    parameters:
      - name: body
        in: body
        required: true
        schema:
          id: 用户注册
          required:
            - username
            - password
            - inn_name
          properties:
            username:
              type: string
              description: 用户名.
            password:
              type: string
              description: 密码.
            inn_name:
              type: string
              description: 客栈名称.
            phone:
              type: string
              description: 手机号.
            wx:
              type: string
              description: 微信.

    responses:
      201:
          description: 注册成功


          example: {'code':1,'message':注册成功}
      406:
        description: 注册有误，参数有误等

    """
    pass

二. 大致介绍及详细文档推荐

flasgger配置文件解析：

在flasgger的配置文件中，以yaml的格式描述了flasgger页面的内容；
tags标签中可以放置对这个api的描述和说明；
parameters标签中可以放置这个api所需的参数，如果是GET方法，可以放置url中附带的请求参数，如果是POST方法，可以将参数放置在schema子标签下面；
responses标签中可以放置返回的信息，以状态码的形式分别列出，每个状态码下可以用schema标签放置返回实体的格式；

只是简单记录，其他可以看下面一些链接

使用swagger 生成 Flask RESTful API swagger文档在线编辑样例 swagger和openAPI: 描述参数 flasgger

本文参与腾讯云自媒体分享计划，分享自作者个人站点/博客。

原始发表：2019-03-21 ，如有侵权请联系 cloudcommunity@tencent.com 删除

java