Skip to content

Commit 23fb2ef

Browse files
authored
Update swagger.md
1 parent 81ee38e commit 23fb2ef

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

core/swagger.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Swagger / Open API Support
22

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.
44
It also integrates a customized version of [Swagger UI](https://swagger.io/swagger-ui/), a nice tool to display the
55
API documentation in a user friendly way.
66

@@ -370,11 +370,9 @@ As described [in the Symfony documentation](https://symfony.com/doc/current/temp
370370

371371
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.
372372

373-
### Enable Swagger doc for API Gateway
373+
# Compatibilily Layer with Amazon API Gateway
374374

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.
377377

378-
To enable API Gateway compatibility on your Swagger doc, add `api_gateway=true` query parameter:
379-
380-
`http://www.example.com/docs.json?api_gateway=true`
378+
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

Comments
 (0)