Как указать чванство, когда конечная точка поддерживает более одного типа? - PullRequest
Новая
       71

Как указать чванство, когда конечная точка поддерживает более одного типа?

0 голосов
/ 26 марта 2020

Ниже приведен пример кода, который показывает сваггер для конечной точки GET. Предположим, я хочу расширить конечную точку для поддержки как GET, так и POST, тогда я изменю значение @app.route('/colors/<palette>/', methods=['GET']) на @app.route('/colors/<palette>/', methods=['POST', 'GET']). Как мне теперь указать c чванство для POST? 

from flask import Flask, jsonify
from flasgger import Swagger

app = Flask(__name__)
swagger = Swagger(app)

@app.route('/colors/<palette>/', methods=['GET'])
def colors(palette):
    """Example endpoint returning a list of colors by palette
    This is using docstrings for specifications.
    ---
    parameters:
      - name: palette
        in: path
        type: string
        enum: ['all', 'rgb', 'cmyk']
        required: true
        default: all
    definitions:
      Palette:
        type: object
        properties:
          palette_name:
            type: array
            items:
              $ref: '#/definitions/Color'
      Color:
        type: string
    responses:
      200:
        description: A list of colors (may be filtered by palette)
        schema:
          $ref: '#/definitions/Palette'
        examples:
          rgb: ['red', 'green', 'blue']
    """
    all_colors = {
        'cmyk': ['cian', 'magenta', 'yellow', 'black'],
        'rgb': ['red', 'green', 'blue']
    }
    if palette == 'all':
        result = all_colors
    else:
        result = {palette: all_colors.get(palette)}

    return jsonify(result)

app.run(debug=True)
...