You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: core/swagger.md
+5-7Lines changed: 5 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Swagger / Open API Support
2
2
3
-
API Platform natively support the [Open API](https://www.openapis.org/) (formerly Swagger) API documentation format.
3
+
API Platform natively supports the [Open API](https://www.openapis.org/) (formerly Swagger) API specification format.
4
4
It also integrates a customized version of [Swagger UI](https://swagger.io/swagger-ui/), a nice tool to display the
5
5
API documentation in a user friendly way.
6
6
@@ -370,11 +370,9 @@ As described [in the Symfony documentation](https://symfony.com/doc/current/temp
370
370
371
371
You may want to copy the [one shipped with API Platform](https://github.com/api-platform/core/blob/master/src/Bridge/Symfony/Bundle/Resources/views/SwaggerUi/index.html.twig) and customize it.
372
372
373
-
### Enable Swagger doc for API Gateway
373
+
# Compatibilily Layer with Amazon API Gateway
374
374
375
-
[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).
376
-
Fortunately, API Platform provides a way to be compatible with both Swagger 2.0 & API Gateway.
375
+
[AWS API Gateway](https://aws.amazon.com/api-gateway/) supports OpenAPI partially, but it [requires some changes](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.html).
376
+
Fortunately, API Platform provides a way to be compatible with Amazon API Gateway.
377
377
378
-
To enable API Gateway compatibility on your Swagger doc, add `api_gateway=true` query parameter:
To enable API Gateway compatibility on your OpenAPI docs, add `api_gateway=true` as query parameter: `http://www.example.com/docs.json?api_gateway=true`
0 commit comments