How to Write Input Check Information to the Swagger YAML

I am making a swagger-style YAML with OpenAPI 3.0, but I am having trouble writing input check information for the API.
Please let me know which block and which properties I should use.

yaml openapi swagger

2022-09-30 21:54

1 Answers

The minimum, maximum, and limitations of input items are described in the Schema Object.

https://swagger.io/specification/ #schema-object

For number/integer/string, data type definitions can be subdivided using the format field.

https://swagger.io/specification/ #data-types

Here's a simple example:

 schema:
  type:object
  properties:
    comment:
      type:string
      minimum —0# Minimum 0 characters 
      maximum : 10 # up to 10 characters 
    updateAt:
      type:string
      format:date# Date format according to RFC 3339

2022-09-30 21:54

If you have any answers or tips

Popular Tags

python x 4647

android x 1593

java x 1494

javascript x 1427

c x 927

c++ x 878

ruby-on-rails x 696

php x 692

python3 x 685

html x 656