API Documentation #1715
p5
started this conversation in
Feature Requests
Replies: 1 comment
-
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 |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
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
Beta Was this translation helpful? Give feedback.
All reactions