I'm not able to view the content of these two pages:

  • admin/config/services/openapi/redoc/rest
  • admin/config/services/openapi/redoc/jsonapi

They crash my browser. It is evidently just too much documentation for one page. I wish there were another interface to this documentation, because I need to see it and have no way to do so. I have tried on multiple browsers and on a few different computers. The pages always crash.

Comments

arnoldbird created an issue. See original summary.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Title: ReDoc documentation pages are unusable -- load way to slowly and crash browser » ReDoc documentation pages may be very slow to load on certain Drupal sites and certain computers: so many entity types/bundles to document!
Category: Bug report » Task
Issue tags: +Performance, +Usability, +Needs upstream bugfix

Drupal exposes lots of data. ReDoc apparently is not designed to scale for huge APIs.

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented
Issue tags: +API-First Initiative
richgerdes’s picture

richgerdes
he/him
Primary language English
Location New Jersey, USA
commented
Related issues: +#2874891: Allow filtering doc pages per resource, +#2948570: Refactor doc module implementations

@arnoldbird, I will look at splitting this data up into multiple pages, based on entity type. We do already do this for the rest display in SwaggerUI, so it would make sense to do so here.

In the mean time, you can try using the equivalent SwaggerUI interfaces. To do so, ensure that you have the equivalent Swagger UI module, OpenAPI Documentation using Swagger UI (openapi_swagger_ui), enabled. You should then be able to navigate to

admin/config/services/openapi/swagger-ui/jsonapi and
admin/config/services/openapi/swagger-ui/rest

For rest, the swagger ui module does include per resource displays as well. You can find these by going to admin/config/services/openapi/swagger-ui/rest/list-resources. This interface is still not completely finished, and may need some improvements, details can be found in #2874891: Allow filtering doc pages per resource. This issue does raise the desire to improve that interface, I have also been planning something more drastic over all here as part of #2948570: Refactor doc module implementations.