From 48c39a5b2ec6b518f40e0a586c6673a329a95027 Mon Sep 17 00:00:00 2001 From: Vincent CHALAMON Date: Mon, 12 Feb 2018 12:07:29 +0100 Subject: [PATCH] Add documentation for Swagger doc with api_gateway query parameter --- core/swagger.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/core/swagger.md b/core/swagger.md index 6bb153b28d1..9e3c370cb09 100644 --- a/core/swagger.md +++ b/core/swagger.md @@ -204,3 +204,12 @@ swagger_ui: ``` Change `/docs` to your desired URI you wish Swagger to be accessible on. + +### Enable Swagger doc for API Gateway + +[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). +Fortunately, API Platform provides a way to be compatible with both Swagger 2.0 & API Gateway. + +To enable API Gateway compatibility on your Swagger doc, add `api_gateway=true` query parameter: + +`http://www.example.com/docs.json?api_gateway=true`