Project structure finished - #2
Merged
Merged
Conversation
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
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.
This pull request introduces several improvements to the CommunityHub project, focusing on enhanced API documentation, better security configuration, and updates to the project documentation. The main highlights are the integration of Swagger/OpenAPI for all services, improved developer onboarding via a more comprehensive
README.md, and refactoring of the authentication response for consistency.API Documentation & Security:
user-service,incident-service, andpoll-service) by including thespringdoc-openapi-starter-webmvc-uidependency in their respectivepom.xmlfiles. This enables interactive API documentation via Swagger UI. [1] [2] [3]user-servicesecurity configuration to allow public access to Swagger UI and OpenAPI documentation endpoints, ensuring they are accessible without authentication.SwaggerConfigclass inuser-serviceto define JWT bearer authentication in the OpenAPI docs, making it clear how to authorize requests in Swagger UI.Authentication Response Refactoring:
/loginendpoint inUserControllerto return a structuredTokenResponseDTOobject instead of a plain string, improving API consistency and documentation. [1] [2] [3]Project Documentation:
README.mdwith detailed project overview, architecture diagrams, technology stack, setup instructions, and contribution guidelines, making it much easier for new developers to understand and get started with the project.readme.mdfile to avoid confusion.These changes collectively improve the developer experience, API usability, and maintainability of the project.