Swagger like solution for documenting APIs?

[fnick851]

I know with next-drupal front end developers do not work directly with the RESTful API endpoints.

But is there a solution similar to Swagger that documents all the possible APIs that the front end can call? I think this helps if the front end developer does not work on the Drupal backend. He/she might has little knowledge and need to look up a documentation for APIs.

Thanks.

[shadcn]

Drupal has OpenAPI which works with Swagger.

Can you give this a try?

[shadcn]

@fnick851 Did this work?

[devtim123]

Yes this works, but can be little slow on client browser because json:api-documentation is quite big.

also redoc is an option, but performance is issue as well there.

for swagger-ui this patch here can be helpful the have filter option avaiable: https://www.drupal.org/project/openapi_ui_swagger/issues/3259746

what also would be nice if types can be generated with orval or something else...