Skip to content

Commit d7c52ff

Browse files
authored
Added mention about OpenAPI (#2836)
* Added mention about OpenAPI * Added mention about local doc
1 parent f8dd231 commit d7c52ff

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/api/rest_api/rest_api_usage/rest_api_usage.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@ Every interaction with the repository than you can do from back office or by usi
1111

1212
The REST API uses HTTP methods (such as `GET` and `PUBLISH`), and HTTP headers to specify the type of request.
1313

14+
## OpenAPI support
15+
16+
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.
17+
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:
19+
20+
``` bash
21+
php bin/console ibexa:openapi --output=openapi.json # JSON output
22+
php bin/console ibexa:openapi --yaml --output=openapi.yaml # YAML output
23+
```
24+
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.
30+
1431
## URIs
1532

1633
The REST API is designed in such a way that the client can explore the Repository without constructing any URIs to resources.

0 commit comments

Comments
 (0)