How psmri/helpline1097-api works
Project type and purpose
• This is a standalone Spring-Boot microservice (HelpLine1097 API) written in Java 8, built with Maven.
• Its purpose is to expose RESTful endpoints for a national AIDS helpline (inbound/outbound calls), manage counseling/referral/feedback workflows, and synchronize beneficiary adherence data with an external “Everwell” system.
• It uses MySQL for persistence, Redis for caching/session management, JWT for authentication, and Swagger for API documentation.
File structure
• Top-level artifacts:
• Dockerfile, pom.xml, .github/workflows (CI/CD pipelines for build, SAST, packaging).
• src/main/java: standard layered packages:
– config (CORS, interceptors, Redis, Swagger)
– controller (REST controllers grouped by functional domain)
– service (business logic interfaces + implementations)
– repository (Spring Data repositories + custom implementations)
– data (entity/DTO classes organized by domain)
– utils (JWT, HTTP interceptors, mappers, email gateway, Redis storage, exception handling)
– src/main/resources: application.properties, logging config.
• Environment files under src/main/environment for CI, Docker, examples.
• Tests under src/test/java targeting the main application class.
Insights from README
• Actors: Counseling Officer (CO) and Supervisor consume the API.
• Four core feature areas: Information, Counseling, Referral, Feedback.
• Outbound integration: fetch beneficiaries with missed doses from Everwell, call them, capture responses, and push updates back.
• Exposes all capabilities over REST with Swagger UI.