Add comprehensive OpenAPI/Swagger API documentation

- Install swagger-ui-express and swagger-jsdoc dependencies
- Create comprehensive OpenAPI 3.0 specification with detailed schemas
- Add interactive Swagger UI at /api-docs endpoint
- Document all public API endpoints (/api/config, /api/locations)
- Document admin authentication and management endpoints
- Include comprehensive request/response schemas and examples
- Add authentication documentation for admin endpoints
- Update CLAUDE.md with API documentation information

Features:
- Complete API specification with OpenAPI 3.0 standard
- Interactive documentation interface with Swagger UI
- Detailed request/response examples for all endpoints
- Authentication flows for admin functionality
- Error response documentation with examples
- Type-safe integration with existing TypeScript architecture

API Documentation available at: /api-docs

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Claude Code 2025-07-05 21:21:31 -04:00
parent 13c0b8b457
commit 612475727e
8 changed files with 906 additions and 14 deletions

View file

@ -24,7 +24,9 @@
"dotenv": "^17.0.1",
"express": "^4.18.2",
"node-cron": "^3.0.3",
"sqlite3": "^5.1.6"
"sqlite3": "^5.1.6",
"swagger-jsdoc": "^6.2.8",
"swagger-ui-express": "^5.0.1"
},
"devDependencies": {
"@types/cors": "^2.8.19",
@ -32,6 +34,8 @@
"@types/node": "^24.0.10",
"@types/node-cron": "^3.0.11",
"@types/sqlite3": "^3.1.11",
"@types/swagger-jsdoc": "^6.0.4",
"@types/swagger-ui-express": "^4.1.8",
"concurrently": "^9.2.0",
"jest": "^29.7.0",
"nodemon": "^3.1.10",