✨feat: add Swagger UI for API documentation #90
Merged
Conversation
This file contains 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
- implement `Swagger` documentation for REST API endpoints - add `Swagger` annotations to API handlers and models - update `Echo` server to serve `Swagger UI` at /swagger/* - add new make task for generating `Swagger` files - include new dependencies for `Swagger` integration - update tests to cover `Swagger` endpoint changes - generate initial `Swagger` documentation files
- rename directory structure from `api/jrp` to `api/jrp-server` for better clarity - update related import paths and references in all affected files - modify `Makefile.toml` to reflect the new directory structure - update swagger documentation with new module path
- add API server documentation including setup and usage instructions - add environment variables section for API server configuration - add installation and uninstallation guide for API server - restructure document headers to improve readability - update CLI section descriptions to be more concise
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Swaggerdocumentation for REST API endpointsSwaggerannotations to API handlers and modelsEchoserver to serveSwagger UIat /swagger/*SwaggerfilesSwaggerintegrationSwaggerendpoint changesSwaggerdocumentation files