Skip to content

Project structure finished - #2

Merged
Lvasp16rnd merged 3 commits into
mainfrom
develop
Jul 14, 2026
Merged

Project structure finished #2
Lvasp16rnd merged 3 commits into
mainfrom
develop

Conversation

@Lvasp16rnd

Copy link
Copy Markdown
Owner

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:

  • Added Swagger/OpenAPI support to all three services (user-service, incident-service, and poll-service) by including the springdoc-openapi-starter-webmvc-ui dependency in their respective pom.xml files. This enables interactive API documentation via Swagger UI. [1] [2] [3]
  • Updated the user-service security configuration to allow public access to Swagger UI and OpenAPI documentation endpoints, ensuring they are accessible without authentication.
  • Introduced a SwaggerConfig class in user-service to define JWT bearer authentication in the OpenAPI docs, making it clear how to authorize requests in Swagger UI.

Authentication Response Refactoring:

  • Changed the /login endpoint in UserController to return a structured TokenResponseDTO object instead of a plain string, improving API consistency and documentation. [1] [2] [3]

Project Documentation:

  • Significantly expanded the main README.md with 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.
  • Removed the old/duplicate readme.md file to avoid confusion.

These changes collectively improve the developer experience, API usability, and maintainability of the project.

@Lvasp16rnd
Lvasp16rnd merged commit 931c44c into main Jul 14, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant