feat: Add Swagger UI with OpenAPI annotations#24
Open
ayshishannidhya wants to merge 1 commit intoOpenElements:mainfrom
Open
feat: Add Swagger UI with OpenAPI annotations#24ayshishannidhya wants to merge 1 commit intoOpenElements:mainfrom
ayshishannidhya wants to merge 1 commit intoOpenElements:mainfrom
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
- Add OpenApiConfig with API metadata (title, description, version, license) - Add OpenAPI annotations (@operation, @parameter, @apiresponse, @tag) to all API endpoints in ApiEndpoint.java - Configure springdoc Swagger UI and API docs paths in application.yml The springdoc-openapi-starter-webmvc-ui dependency was already present in pom.xml. Swagger UI will be available at /swagger-ui.html when the application is running. Closes OpenElements#4 Signed-off-by: Ankit <asp45624@gmail.com>
ayshishannidhya
force-pushed
the
add-swagger-ui
branch
from
db33dab to
564bcc8
Compare
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
This PR adds Swagger UI support to the Good First Issue Provider application.
Changes
@Tagfor grouping endpoints@Operationwith summary and description for each endpoint@Parameterdescriptions for all query parameters@ApiResponsefor documenting response codesHow to access
Once the application is running, Swagger UI is available at:
/swagger-ui.html/v3/api-docsNotes
The
springdoc-openapi-starter-webmvc-uidependency was already present inpom.xml, so no dependency changes were needed.Closes #4