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

一. 部分代碼及效果

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/[email protected]/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