Skip to content

Commit 1c73afc

Browse files
committed
update README.md with healthcheck endpoint description
1 parent 9c83278 commit 1c73afc

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,27 @@ This is a social media-style API where users can create posts, and other users c
208208

209209
### API Endpoints Reference
210210

211+
#### ❤️ Health Check
212+
213+
##### Check Application Health
214+
215+
```http
216+
GET /
217+
```
218+
219+
**Response:**
220+
221+
```json
222+
{
223+
"status": "healthy",
224+
"message": "FastAPI is running"
225+
}
226+
```
227+
228+
Used by deployment platforms (like Render) to verify the application is running correctly.
229+
230+
---
231+
211232
#### 🔐 Authentication & Users
212233

213234
##### Register a New User

0 commit comments

Comments
 (0)