25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

155 lines
5.3 KiB

  1. openapi: "3.0.0"
  2. info:
  3. version: 1.0.0
  4. title: Swagger Petstore
  5. description: A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification
  6. termsOfService: http://swagger.io/terms/
  7. contact:
  8. name: Swagger API Team
  9. email: apiteam@swagger.io
  10. url: http://swagger.io
  11. license:
  12. name: Apache 2.0
  13. url: https://www.apache.org/licenses/LICENSE-2.0.html
  14. servers:
  15. - url: http://petstore.swagger.io/api
  16. paths:
  17. /pets:
  18. get:
  19. description: |
  20. Returns all pets from the system that the user has access to
  21. Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
  22. Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
  23. operationId: findPets
  24. parameters:
  25. - name: tags
  26. in: query
  27. description: tags to filter by
  28. required: false
  29. style: form
  30. schema:
  31. type: array
  32. items:
  33. type: string
  34. - name: limit
  35. in: query
  36. description: maximum number of results to return
  37. required: false
  38. schema:
  39. type: integer
  40. format: int32
  41. responses:
  42. '200':
  43. description: pet response
  44. content:
  45. application/json:
  46. schema:
  47. type: array
  48. items:
  49. $ref: '#/components/schemas/Pet'
  50. default:
  51. description: unexpected error
  52. content:
  53. application/json:
  54. schema:
  55. $ref: '#/components/schemas/Error'
  56. post:
  57. description: Creates a new pet in the store. Duplicates are allowed
  58. operationId: addPet
  59. requestBody:
  60. description: Pet to add to the store
  61. required: true
  62. content:
  63. application/json:
  64. schema:
  65. $ref: '#/components/schemas/NewPet'
  66. responses:
  67. '200':
  68. description: pet response
  69. content:
  70. application/json:
  71. schema:
  72. $ref: '#/components/schemas/Pet'
  73. default:
  74. description: unexpected error
  75. content:
  76. application/json:
  77. schema:
  78. $ref: '#/components/schemas/Error'
  79. /pets/{id}:
  80. get:
  81. description: Returns a user based on a single ID, if the user does not have access to the pet
  82. operationId: find pet by id
  83. parameters:
  84. - name: id
  85. in: path
  86. description: ID of pet to fetch
  87. required: true
  88. schema:
  89. type: integer
  90. format: int64
  91. responses:
  92. '200':
  93. description: pet response
  94. content:
  95. application/json:
  96. schema:
  97. $ref: '#/components/schemas/Pet'
  98. default:
  99. description: unexpected error
  100. content:
  101. application/json:
  102. schema:
  103. $ref: '#/components/schemas/Error'
  104. delete:
  105. description: deletes a single pet based on the ID supplied
  106. operationId: deletePet
  107. parameters:
  108. - name: id
  109. in: path
  110. description: ID of pet to delete
  111. required: true
  112. schema:
  113. type: integer
  114. format: int64
  115. responses:
  116. '204':
  117. description: pet deleted
  118. default:
  119. description: unexpected error
  120. content:
  121. application/json:
  122. schema:
  123. $ref: '#/components/schemas/Error'
  124. components:
  125. schemas:
  126. Pet:
  127. allOf:
  128. - $ref: '#/components/schemas/NewPet'
  129. - required:
  130. - id
  131. properties:
  132. id:
  133. type: integer
  134. format: int64
  135. NewPet:
  136. required:
  137. - name
  138. properties:
  139. name:
  140. type: string
  141. tag:
  142. type: string
  143. Error:
  144. required:
  145. - code
  146. - message
  147. properties:
  148. code:
  149. type: integer
  150. format: int32
  151. message:
  152. type: string