API Documentation

[p5]

What version of starlight are you using?

0.0.0

What is your idea?

Redoc is a library / tool for turning Swagger and OpenAPI specs into nice UIs.
It comes as a HTML tag or React component.

Since Starlight is used for documentation, it would also be good to add native support for rendering API documentation given the JSON spec file.

Why is this feature necessary?

We have text documentation, but no way of natively (I.E. without introducing additional external dependencies or defining in Markdown) displaying API documentation.

Do you have examples of this feature in other projects?

No response

Participation

• I am willing to submit a pull request for this feature.

[HiDeoo]

Thanks for your request 🙌

Only my personal opinion, but I think having Swagger and OpenAPI support natively in Starlight could feel a bit too opinionated and would add a lot of maintenance overhead to the project. I think a community plugin would be a better approach for this specific use case.

As far as I know, there is not yet any plugin for Redoc but there is a starlight-openapi one.

[HiDeoo]

We are particulary happy with the current approach relying on Starlight plugins to handle such use cases, e.g. starlight-openapi, starlight-typedoc, etc.

It avoids adding a lot of maintenance burden to the core Starlight codebase, while allowing users to extend Starlight with their own custom features or 3rd-party plugins, and plugin can move at their own pace.

Considering this, I'm going to close this discussion as Redoc support is not something we plan to add to Starlight core, but rather something that could be implemented as a plugin.