Add auto-generated API reference documentation#131
Merged
Conversation
- Add @orpc/openapi and @orpc/zod for OpenAPI spec generation from router - Create scripts/generate-openapi.ts to generate openapi.json from oRPC router - Add docusaurus-plugin-openapi-docs to render API docs in Docusaurus - Configure build to regenerate API docs on each build - Add API Reference section at bottom of docs sidebar (52 endpoints)
Instead of generating at build time, commit the generated files so the docs workflow doesn't need to run bun/generate scripts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds automatic API reference documentation generated from the oRPC router, appearing at the bottom of the Docusaurus sidebar.
Changes
@orpc/openapiand@orpc/zodfor OpenAPI spec generationscripts/generate-openapi.tsto generateopenapi.jsonfrom oRPC routerdocusaurus-plugin-openapi-docsto render API docsBuild Flow
The API docs are auto-generated and gitignored, so they stay in sync with the router automatically.