

OpenAPI 3.0 で swagger 形式の YAML を作ってるのですが、API の入力チェック情報の書き方で困っています。  
どのブロックにどのプロパティを使って書けばいいのか教えていただきたいです。


CC BY-SA 4.0
2020-12-15T07:00:30.727
72668
2020-12-15T13:28:08.017
2020-12-15T07:52:46.997
3060
42671
question
yaml openapi swagger
swaggerのYAMLに入力チェック情報を書く方法


入力項目の長さの最小値、最大値、入力項目の制限はSchema Objectに記述します。

  * <https://swagger.io/specification/#schema-object>

number / integer / string においてはデータの型定義は`format`フィールドを利用して細分化できます。

  * <https://swagger.io/specification/#data-types>

簡単な例ですが次のようになります。

[code]

    schema:
      type: object
      properties:
        comment:
          type: string
          minimum: 0    # 最小 0文字 
          maximum: 10   # 最大10文字 
        updateAt:
          type: string
          format: date  # RFC3339に則った日付形式
    
[/code]


CC BY-SA 4.0
2020-12-15T13:28:08.017
72675
2020-12-15T13:28:08.017
7997
72668
answer