OpenAPI 3.0 사용 방법(GET 매개변수 포함)

설명 사양

openapi: 3.0.2
info:
  description: ユーザ名を与えると挨拶を返してくれるAPI
  version: 1.0.0
  title: Hello
tags:
  - name: hello
    description: ユーザに挨拶を返すAPI
paths:
  /hello:
    get:
      tags:
        - hello
      description: ユーザに挨拶する。
      operationId: getHello
      parameters:
        - name: userName
          in: query
          description: ユーザ名
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  HelloUser:
                    type: string
                    example: Hello, userName
        "400":
          description: Bad Request
        "500":
          description: Internal Server Error

Flash 서버 만들기

unzip python-flask-server-generated.zip

pip3 install -r requirements.txt

（省略）
#    return 'do some magic!'
    return 'Hello, ' + user_name + ' !'

python3 -m swagger_server

$ http http://0.0.0.0:8080/hello?userName=Scott
HTTP/1.0 200 OK
Content-Length: 17
Content-Type: application/json
Date: Fri, 22 Oct 2021 02:47:57 GMT
Server: Werkzeug/1.0.1 Python/3.9.7

"Hello, Scott !"