Bill
8dd4f0ca63
- Bootstrap script for creating monorepo projects - FastAPI backend templates with uv, ruff, mypy, pytest - React frontend templates with TypeScript, ESLint, Prettier - Docker Compose setup with backend, frontend, and database - 9 development and CI scripts - Gitea Actions CI/CD workflows - Comprehensive documentation (8 files) - 45 template files for complete project structure - Automated verification script (all tests pass) - Based on coding-agent-rules standards
80 lines
1.3 KiB
Markdown
80 lines
1.3 KiB
Markdown
# API Documentation
|
|
|
|
## Overview
|
|
|
|
The API is built with FastAPI and follows REST principles.
|
|
|
|
## Base URL
|
|
|
|
- **Development**: `http://localhost:8000`
|
|
- **API Prefix**: `/api/v1`
|
|
|
|
## Interactive Documentation
|
|
|
|
FastAPI provides automatic interactive API documentation:
|
|
|
|
- **Swagger UI**: http://localhost:8000/docs
|
|
- **ReDoc**: http://localhost:8000/redoc
|
|
|
|
## Authentication
|
|
|
|
(Add authentication details here when implemented)
|
|
|
|
## Endpoints
|
|
|
|
### Health Check
|
|
|
|
```
|
|
GET /health
|
|
```
|
|
|
|
Returns the health status of the API.
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"status": "healthy"
|
|
}
|
|
```
|
|
|
|
### Root
|
|
|
|
```
|
|
GET /
|
|
```
|
|
|
|
Returns basic API information.
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"message": "Welcome to the API",
|
|
"version": "0.1.0"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
All error responses follow this format:
|
|
|
|
```json
|
|
{
|
|
"detail": "Error message here"
|
|
}
|
|
```
|
|
|
|
### Common Status Codes
|
|
|
|
- **200 OK** - Request succeeded
|
|
- **201 Created** - Resource created successfully
|
|
- **400 Bad Request** - Invalid request data
|
|
- **401 Unauthorized** - Authentication required
|
|
- **403 Forbidden** - Insufficient permissions
|
|
- **404 Not Found** - Resource not found
|
|
- **422 Unprocessable Entity** - Validation error
|
|
- **500 Internal Server Error** - Server error
|
|
|
|
## Changelog
|
|
|
|
See [CHANGELOG.md](./CHANGELOG.md) for API changes and migration notes.
|