Redoc as OpenAPI reader

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Release notes

Problem to solve

Formerly known as Swagger, OpenAPI is an initiative to standardize the way an API is documented. Today, Gitlab previews openapi file with the Swagger preview UI. Unfortunately details of the API are not well displayed in the current implementation of Swagger UI: https://github.com/swagger-api/swagger-ui/issues/4581.

Redoc also implemented a previewer of OpenAPI files in a better format: https://github.com/swagger-api/swagger-ui/issues/6364

As a developper, I would like to read API definition file (OpenAPI) rendered by redoc while browsing my GitLab repositories to easily understand others APIs.

Intended users

User experience goal

The user should be able to inspect API definitions directly in gitlab without having to clone each repository locally to render the openapi file with redoc.

Proposal

Being able to select the rendering backends for the openapi file.

Further details

Permissions and Security

Documentation

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / references

https://github.com/Redocly/redoc

Edited by 🤖 GitLab Bot 🤖