How nhsdigital/eligibility-signposting-api works
Project Type and Purpose
• This is a Python‐based microservice (“Eligibility Signposting API”) whose sole responsibility is to assess and signpost an individual’s vaccination eligibility.
• It is a backend API service, typically deployed as an AWS Lambda (or container) behind API Gateway, persisting data in DynamoDB and loading configurable rules from S3.
File Structure Insights
• src/eligibility_signposting_api
• views/ – presentation layer (HTTP endpoints)
• services/ – business logic layer (eligibility calculations, rule evaluation)
• repos/ – data access layer (DynamoDB repository, S3 rules reader)
• app.py – wiring module (dependency injection via WireUp)
• infrastructure/
– Terraform modules & stacks provisioning AWS resources: API layer, DynamoDB tables, S3 buckets, IAM roles & policies, VPC/networking, bootstrap.
• tests/
– unit, integration (including Lambda‐in-process tests), uses localstack via pytest-docker.
• .github/ & scripts/
– CI/CD pipelines (GitHub Actions), linting, security scans, Makefile wrappers.
README Architectural Notes
• Adheres to Martin Fowler’s Separated Presentation → Service Layer → Repository layering.
• Uses Pydantic for models, WireUp for dependency injection.
Architectural Patterns & Design Principles
• Layered Architecture: clear separation of concerns (Presentation, Business, Data).
• Dependency Injection via WireUp for loose coupling & testability.
• Configuration-as-Code: Terraform modules & stacks for infra, parameterised by environment.
• Testability: localstack + pytest fixtures for full-stack integration tests.