main.yaml 807 B

123456789101112131415161718192021222324
  1. openapi: 3.0.0
  2. info:
  3. title: Sample API
  4. description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
  5. version: 0.1.9
  6. servers:
  7. - url: http://api.example.com/v1
  8. description: Optional server description, e.g. Main (production) server
  9. - url: http://staging-api.example.com
  10. description: Optional server description, e.g. Internal staging server for testing
  11. paths:
  12. /users:
  13. get:
  14. summary: Returns a list of users.
  15. description: Optional extended description in CommonMark or HTML.
  16. responses:
  17. "200": # status code
  18. description: A JSON array of user names
  19. content:
  20. application/json:
  21. schema:
  22. type: array
  23. items:
  24. type: string