Skip to content

Commit bdeb514

Browse files
docs: Add comprehensive testing section to README
1 parent 0b3ded8 commit bdeb514

1 file changed

Lines changed: 27 additions & 3 deletions

File tree

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,16 +136,40 @@ The server will start at `http://127.0.0.1:8000`
136136

137137
## Testing
138138

139+
The project has **comprehensive test coverage** with **91+ test functions** across 11 test files:
140+
141+
-**All endpoints covered**: Every API endpoint has dedicated tests
142+
-**Error handling**: Validation errors, business logic errors, guards
143+
-**Edge cases**: Boundary conditions, extreme values, zero cases
144+
-**Integration tests**: Round-trip operations and consistency checks
145+
-**Response format**: All tests verify standard response structure
146+
147+
See [TEST_COVERAGE.md](TEST_COVERAGE.md) for detailed coverage documentation.
148+
149+
### Run Tests
150+
151+
```bash
152+
# Run all tests
153+
pytest
154+
155+
# Run with coverage report
156+
pytest --cov=app --cov-report=html
157+
158+
# Run specific test file
159+
pytest tests/test_health.py
160+
```
161+
139162
### Interactive API Documentation (Swagger UI)
140163
Open in your browser: http://127.0.0.1:8000/docs
141164

142-
### Health Check
165+
### Manual Testing Examples
166+
167+
**Health Check:**
143168
```bash
144169
curl http://127.0.0.1:8000/v1/health
145170
```
146171

147-
### Echo Endpoint
148-
Test via Swagger UI at `/docs` or use curl:
172+
**Echo Endpoint:**
149173
```bash
150174
curl -X POST http://127.0.0.1:8000/v1/echo \
151175
-H "Content-Type: application/json" \

0 commit comments

Comments
 (0)