Enhance API documentation with Swagger #34
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
Fixes DEVRhylme-Foundation#5 Add Swagger API documentation to the project. * **internal/structure/structure.go** - Add a new function `AddSwaggerDocs` to set up Swagger documentation. - Call `AddSwaggerDocs` in `CreateBaseFileStructure` after copying the directory. * **.templates/jsbase/src/app.js** - Import `swagger-ui-express` and `swagger-jsdoc`. - Define Swagger documentation in JSDoc format. - Set up Swagger UI to serve at `/api-docs`. * **.templates/tsbase/src/app.ts** - Import `swagger-ui-express` and `swagger-jsdoc`. - Define Swagger documentation in JSDoc format. - Set up Swagger UI to serve at `/api-docs`. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/DEVRhylme-Foundation/expressify/issues/5?shareId=XXXX-XXXX-XXXX-XXXX).
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.
Fixes #5
Add Swagger API documentation to the project.
internal/structure/structure.go
AddSwaggerDocsto set up Swagger documentation.AddSwaggerDocsinCreateBaseFileStructureafter copying the directory..templates/jsbase/src/app.js
swagger-ui-expressandswagger-jsdoc./api-docs..templates/tsbase/src/app.ts
swagger-ui-expressandswagger-jsdoc./api-docs.