Skip to content

Commit 8066815

Browse files
committed
Add quick API smoke test to README.
Document a curl health-check command so contributors can verify the FastAPI service immediately after startup. Made-with: Cursor
1 parent 3b5954e commit 8066815

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,14 @@ uvicorn api.app:app --reload
156156
API base URL: `http://127.0.0.1:8000`
157157
Swagger docs: `http://127.0.0.1:8000/docs`
158158

159+
### Quick API smoke test
160+
161+
After starting FastAPI, verify service health with:
162+
163+
```bash
164+
curl -s http://127.0.0.1:8000/health
165+
```
166+
159167
## API Endpoints (Current)
160168

161169
- `GET /health` -> Health status

0 commit comments

Comments
 (0)