Skip to content

Commit 698c841

Browse files
committed
Added mention about local doc
1 parent 7ab699f commit 698c841

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/api/rest_api/rest_api_usage/rest_api_usage.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,18 @@ The REST API uses HTTP methods (such as `GET` and `PUBLISH`), and HTTP headers t
1515

1616
The REST API is built on top of [API Platform](https://api-platform.com/docs/symfony/) and meets the [OpenAPI](https://www.openapis.org/) standard.
1717

18-
You can downlaod the OpenAPI specification from the [REST API Reference](/api/rest_api/rest_api_reference/rest_api_reference.html), or generate it for your project by running one of the command below:
18+
You can download the OpenAPI specification from the [REST API Reference](/api/rest_api/rest_api_reference/rest_api_reference.html), or generate it for your project by running one of the commands below:
1919

2020
``` bash
21-
php bin/console ibexa:openapi --output=spec.json # JSON output
22-
php bin/console ibexa:openapi --yaml --output=spec.yaml # YAML output
21+
php bin/console ibexa:openapi --output=openapi.json # JSON output
22+
php bin/console ibexa:openapi --yaml --output=openapi.yaml # YAML output
2323
```
2424

25-
With the specification file you can use the [available OpenAPI tools](https://tools.openapis.org/) to work faster with the API, for example, by generating libraries and clients for the API.
25+
Use the specification file with [available OpenAPI tools](https://tools.openapis.org/) to work faster with the API, for example, by generating libraries and clients for the API.
26+
27+
!!! info
28+
29+
In [Symfony's `dev` environment](environments.md), you can access a REST API reference generated for your project by visiting the `/api/ibexa/v2/doc` route in the browser.
2630

2731
## URIs
2832

0 commit comments

Comments
 (0)