Skip to content

Added mention about OpenAPI #2836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 21, 2025
Merged

Added mention about OpenAPI #2836

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ab699f
Added mention about OpenAPI
mnocon Jul 18, 2025
698c841
Added mention about local doc
mnocon Jul 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/api/rest_api/rest_api_usage/rest_api_usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@

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

## OpenAPI support

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.

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:

Check warning on line 18 in docs/api/rest_api/rest_api_usage/rest_api_usage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/rest_api/rest_api_usage/rest_api_usage.md#L18 

[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.
Raw output 
{"message": "[Ibexa.EOLWhitespace] Remove whitespace characters from the end of the line.", "location": {"path": "docs/api/rest_api/rest_api_usage/rest_api_usage.md", "range": {"start": {"line": 18, "column": 202}}}, "severity": "WARNING"}

``` bash
php bin/console ibexa:openapi --output=openapi.json # JSON output
php bin/console ibexa:openapi --yaml --output=openapi.yaml # YAML output
```

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.

Check warning on line 25 in docs/api/rest_api/rest_api_usage/rest_api_usage.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/api/rest_api/rest_api_usage/rest_api_usage.md#L25 

[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.
Raw output 
{"message": "[Ibexa.OxfordComma] Use a comma before the last 'and' or 'or' in a list of four or more items.", "location": {"path": "docs/api/rest_api/rest_api_usage/rest_api_usage.md", "range": {"start": {"line": 25, "column": 87}}}, "severity": "WARNING"}

!!! info

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is when debug is turned on, which is what dev env does. I'm not sure we need to enter into this detail. For me it's OK written like that.

https://github.com/ibexa/rest/blob/main/src/bundle/Resources/config/routing.yml#L16

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd leave it as is as well 👍


## URIs

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