【Swagger】パラメータにenumを使うサンプル

Swagger

パラメータでenum型を指定するサンプルです。in句はbodyとしています。

swagger: "2.0"
info:
  version: "1.0.0"
  title: "test API"
paths:
  /sample:
    post:
      summary: "enum sample"
      description: "パラメータでenum型を宣言する"
      parameters:
        - in: body
          name: user
          description: "This is sample."
          schema:
            type: object
            properties:
              exenum:
                type: "string"
                enum: [
                  aaa,
                  bbb,
                  ccc
                  ]
                example: |
                  aaa:略
                  bbb:略
                  ccc:略
      responses:
        200:
          description: "略"
        400:
          description: "略"
        500:
          description: "略"
タイトルとURLをコピーしました