Skip to content

Commit ea99b64

Browse files
Merge pull request #395 from vincentchalamon/2.1
Add documentation for Swagger doc with api_gateway query parameter
2 parents 007b8ea + 48c39a5 commit ea99b64

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

core/swagger.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,3 +204,12 @@ swagger_ui:
204204
```
205205
206206
Change `/docs` to your desired URI you wish Swagger to be accessible on.
207+
208+
### Enable Swagger doc for API Gateway
209+
210+
[AWS API Gateway](https://aws.amazon.com/api-gateway/) supports Swagger 2.0 partially, but it [requires some changes](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html).
211+
Fortunately, API Platform provides a way to be compatible with both Swagger 2.0 & API Gateway.
212+
213+
To enable API Gateway compatibility on your Swagger doc, add `api_gateway=true` query parameter:
214+
215+
`http://www.example.com/docs.json?api_gateway=true`

0 commit comments

Comments
 (0)