Created
January 4, 2021 01:04
-
-
Save noid11/5b701eb3a5abd67e387241e13c9b81b5 to your computer and use it in GitHub Desktop.
API Gateway のサンプル swagger
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| swagger: '2.0' | |
| info: | |
| description: Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints | |
| title: PetStore | |
| version: 0.0.1 | |
| schemes: | |
| - https | |
| paths: | |
| /: | |
| get: | |
| tags: | |
| - pets | |
| description: PetStore HTML web page containing API usage information | |
| consumes: | |
| - application/json | |
| produces: | |
| - text/html | |
| responses: | |
| '200': | |
| description: Successful operation | |
| headers: | |
| Content-Type: | |
| type: string | |
| description: Media type of request | |
| x-amazon-apigateway-integration: | |
| responses: | |
| default: | |
| statusCode: '200' | |
| responseParameters: | |
| method.response.header.Content-Type: '''text/html''' | |
| responseTemplates: | |
| text/html: |- | |
| <html> | |
| <head> | |
| <style> | |
| body { | |
| color: #333; | |
| font-family: Sans-serif; | |
| max-width: 800px; | |
| margin: auto; | |
| } | |
| </style> | |
| </head> | |
| <body> | |
| <h1>Welcome to your Pet Store API</h1> | |
| <p> | |
| You have successfully deployed your first API. You are seeing this HTML page because the <code>GET</code> method to the root resource of your API returns this content as a Mock integration. | |
| </p> | |
| <p> | |
| The Pet Store API contains the <code>/pets</code> and <code>/pets/{petId}</code> resources. By making a <a href="/$context.stage/pets/" target="_blank"><code>GET</code> request</a> to <code>/pets</code> you can retrieve a list of Pets in your API. If you are looking for a specific pet, for example the pet with ID 1, you can make a <a href="/$context.stage/pets/1" target="_blank"><code>GET</code> request</a> to <code>/pets/1</code>. | |
| </p> | |
| <p> | |
| You can use a REST client such as <a href="https://www.getpostman.com/" target="_blank">Postman</a> to test the <code>POST</code> methods in your API to create a new pet. Use the sample body below to send the <code>POST</code> request: | |
| </p> | |
| <pre> | |
| { | |
| "type" : "cat", | |
| "price" : 123.11 | |
| } | |
| </pre> | |
| </body> | |
| </html> | |
| passthroughBehavior: when_no_match | |
| requestTemplates: | |
| application/json: '{"statusCode": 200}' | |
| type: mock | |
| /pets: | |
| get: | |
| tags: | |
| - pets | |
| summary: List all pets | |
| produces: | |
| - application/json | |
| parameters: | |
| - name: type | |
| in: query | |
| description: The type of pet to retrieve | |
| required: false | |
| type: string | |
| - name: page | |
| in: query | |
| description: Page number of results to return. | |
| required: false | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful operation | |
| schema: | |
| $ref: '#/definitions/Pets' | |
| headers: | |
| Access-Control-Allow-Origin: | |
| type: string | |
| description: URI that may access the resource | |
| x-amazon-apigateway-integration: | |
| responses: | |
| default: | |
| statusCode: '200' | |
| responseParameters: | |
| method.response.header.Access-Control-Allow-Origin: '''*''' | |
| requestParameters: | |
| integration.request.querystring.page: method.request.querystring.page | |
| integration.request.querystring.type: method.request.querystring.type | |
| uri: 'http://petstore.execute-api.ap-northeast-1.amazonaws.com/petstore/pets' | |
| passthroughBehavior: when_no_match | |
| httpMethod: GET | |
| type: http | |
| post: | |
| tags: | |
| - pets | |
| operationId: CreatePet | |
| summary: Create a pet | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| parameters: | |
| - in: body | |
| name: NewPet | |
| required: true | |
| schema: | |
| $ref: '#/definitions/NewPet' | |
| responses: | |
| '200': | |
| description: Successful operation | |
| schema: | |
| $ref: '#/definitions/NewPetResponse' | |
| headers: | |
| Access-Control-Allow-Origin: | |
| type: string | |
| description: URI that may access the resource | |
| x-amazon-apigateway-integration: | |
| responses: | |
| default: | |
| statusCode: '200' | |
| responseParameters: | |
| method.response.header.Access-Control-Allow-Origin: '''*''' | |
| uri: 'http://petstore.execute-api.ap-northeast-1.amazonaws.com/petstore/pets' | |
| passthroughBehavior: when_no_match | |
| httpMethod: POST | |
| type: http | |
| options: | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| responses: | |
| '200': | |
| description: Successful operation | |
| schema: | |
| $ref: '#/definitions/Empty' | |
| headers: | |
| Access-Control-Allow-Origin: | |
| type: string | |
| description: URI that may access the resource | |
| Access-Control-Allow-Methods: | |
| type: string | |
| description: Method or methods allowed when accessing the resource | |
| Access-Control-Allow-Headers: | |
| type: string | |
| description: Used in response to a preflight request to indicate which HTTP headers can be used when making the request. | |
| x-amazon-apigateway-integration: | |
| responses: | |
| default: | |
| statusCode: '200' | |
| responseParameters: | |
| method.response.header.Access-Control-Allow-Methods: '''POST,GET,OPTIONS''' | |
| method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key''' | |
| method.response.header.Access-Control-Allow-Origin: '''*''' | |
| passthroughBehavior: when_no_match | |
| requestTemplates: | |
| application/json: '{"statusCode": 200}' | |
| type: mock | |
| '/pets/{petId}': | |
| get: | |
| tags: | |
| - pets | |
| summary: Info for a specific pet | |
| operationId: GetPet | |
| produces: | |
| - application/json | |
| parameters: | |
| - name: petId | |
| in: path | |
| description: The id of the pet to retrieve | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful operation | |
| schema: | |
| $ref: '#/definitions/Pet' | |
| headers: | |
| Access-Control-Allow-Origin: | |
| type: string | |
| description: URI that may access the resource | |
| x-amazon-apigateway-integration: | |
| responses: | |
| default: | |
| statusCode: '200' | |
| responseParameters: | |
| method.response.header.Access-Control-Allow-Origin: '''*''' | |
| requestParameters: | |
| integration.request.path.petId: method.request.path.petId | |
| uri: 'http://petstore.execute-api.ap-northeast-1.amazonaws.com/petstore/pets/{petId}' | |
| passthroughBehavior: when_no_match | |
| httpMethod: GET | |
| type: http | |
| options: | |
| consumes: | |
| - application/json | |
| produces: | |
| - application/json | |
| parameters: | |
| - name: petId | |
| in: path | |
| description: The id of the pet to retrieve | |
| required: true | |
| type: string | |
| responses: | |
| '200': | |
| description: Successful operation | |
| schema: | |
| $ref: '#/definitions/Empty' | |
| headers: | |
| Access-Control-Allow-Origin: | |
| type: string | |
| description: URI that may access the resource | |
| Access-Control-Allow-Methods: | |
| type: string | |
| description: Method or methods allowed when accessing the resource | |
| Access-Control-Allow-Headers: | |
| type: string | |
| description: Used in response to a preflight request to indicate which HTTP headers can be used when making the request. | |
| x-amazon-apigateway-integration: | |
| responses: | |
| default: | |
| statusCode: '200' | |
| responseParameters: | |
| method.response.header.Access-Control-Allow-Methods: '''GET,OPTIONS''' | |
| method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key''' | |
| method.response.header.Access-Control-Allow-Origin: '''*''' | |
| passthroughBehavior: when_no_match | |
| requestTemplates: | |
| application/json: '{"statusCode": 200}' | |
| type: mock | |
| definitions: | |
| Pets: | |
| type: array | |
| items: | |
| $ref: '#/definitions/Pet' | |
| Empty: | |
| type: object | |
| NewPetResponse: | |
| type: object | |
| properties: | |
| pet: | |
| $ref: '#/definitions/Pet' | |
| message: | |
| type: string | |
| Pet: | |
| type: object | |
| properties: | |
| id: | |
| type: integer | |
| type: | |
| type: string | |
| price: | |
| type: number | |
| NewPet: | |
| type: object | |
| properties: | |
| type: | |
| $ref: '#/definitions/PetType' | |
| price: | |
| type: number | |
| PetType: | |
| type: string | |
| enum: | |
| - dog | |
| - cat | |
| - fish | |
| - bird | |
| - gecko | |
| x-amazon-apigateway-documentation: | |
| version: v2.1 | |
| createdDate: '2016-11-17T07:03:59Z' | |
| documentationParts: | |
| - location: | |
| type: API | |
| properties: | |
| info: | |
| description: Your first API with Amazon API Gateway. This is a sample API that integrates via HTTP with our demo Pet Store endpoints | |
| - location: | |
| type: METHOD | |
| method: GET | |
| properties: | |
| tags: | |
| - pets | |
| description: PetStore HTML web page containing API usage information | |
| - location: | |
| type: METHOD | |
| path: '/pets/{petId}' | |
| method: GET | |
| properties: | |
| tags: | |
| - pets | |
| summary: Info for a specific pet | |
| - location: | |
| type: METHOD | |
| path: /pets | |
| method: GET | |
| properties: | |
| tags: | |
| - pets | |
| summary: List all pets | |
| - location: | |
| type: METHOD | |
| path: /pets | |
| method: POST | |
| properties: | |
| tags: | |
| - pets | |
| summary: Create a pet | |
| - location: | |
| type: PATH_PARAMETER | |
| path: '/pets/{petId}' | |
| method: '*' | |
| name: petId | |
| properties: | |
| description: The id of the pet to retrieve | |
| - location: | |
| type: QUERY_PARAMETER | |
| path: /pets | |
| method: GET | |
| name: page | |
| properties: | |
| description: Page number of results to return. | |
| - location: | |
| type: QUERY_PARAMETER | |
| path: /pets | |
| method: GET | |
| name: type | |
| properties: | |
| description: The type of pet to retrieve | |
| - location: | |
| type: REQUEST_BODY | |
| path: /pets | |
| method: POST | |
| properties: | |
| description: Pet object that needs to be added to the store | |
| - location: | |
| type: RESPONSE | |
| method: '*' | |
| statusCode: '200' | |
| properties: | |
| description: Successful operation | |
| - location: | |
| type: RESPONSE_HEADER | |
| method: OPTIONS | |
| statusCode: '200' | |
| name: Access-Control-Allow-Headers | |
| properties: | |
| description: Used in response to a preflight request to indicate which HTTP headers can be used when making the request. | |
| - location: | |
| type: RESPONSE_HEADER | |
| method: OPTIONS | |
| statusCode: '200' | |
| name: Access-Control-Allow-Methods | |
| properties: | |
| description: Method or methods allowed when accessing the resource | |
| - location: | |
| type: RESPONSE_HEADER | |
| method: '*' | |
| statusCode: '200' | |
| name: Access-Control-Allow-Origin | |
| properties: | |
| description: URI that may access the resource | |
| - location: | |
| type: RESPONSE_HEADER | |
| method: GET | |
| statusCode: '200' | |
| name: Content-Type | |
| properties: | |
| description: Media type of request |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment