Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API_SPECIFICATION

Category: 11. Domain / Industry Hackathons
Section: Phase 2: Technical Blueprint


6. API_SPECIFICATION.md

Purpose: To define endpoints including industry-specific integrations.

You are a senior backend developer specializing in [INDUSTRY NAME] systems.
Using the PRD, Architecture, and Domain Model below, create a complete API specification for this industry hackathon project.

PRD: [PASTE PRD]
ARCHITECTURE: [PASTE SYSTEM_ARCHITECTURE]
DOMAIN_MODEL: [PASTE DOMAIN_MODEL]

For every endpoint provide:
1. HTTP method
2. URL
3. Purpose
4. Authentication requirement
5. Compliance requirements (GDPR, HIPAA, PCI-DSS, KYC)
6. Request parameters
7. Request body
8. Example request
9. Example success response
10. Possible error responses
11. HTTP status codes
12. Audit logging requirements

Include endpoints for industry-specific integrations (Banking APIs, EHR, Government APIs).
Keep the API simple and consistent.
Do not create endpoints that are not required by the product.