| GET |
/api/v1/users |
Retrieve a paginated list of users. |
page, limit |
curl -X GET "https://api.example.com/api/v1/users?page=1&limit=20" |
|
| POST |
/api/v1/users |
Create a new user record. |
name, email, password |
curl -X POST "https://api.example.com/api/v1/users" -H "Content-Type: application/json" -d '{"name":"John Doe","email":"john@example.com","password":"s3cr3t"}' |
|
| GET |
/api/v1/users/:id |
Fetch details of a specific user. |
id (path) |
curl -X GET "https://api.example.com/api/v1/users/123" |
|
| PUT |
/api/v1/users/:id |
Update an existing user. |
id (path), name, email |
curl -X PUT "https://api.example.com/api/v1/users/123" -H "Content-Type: application/json" -d '{"name":"Jane Doe"}' |
|
| DELETE |
/api/v1/users/:id |
Remove a user from the system. |
id (path) |
curl -X DELETE "https://api.example.com/api/v1/users/123" |
|
| GET |
/api/v1/articles |
Get a list of published articles. |
category, tag, page |
curl -X GET "https://api.example.com/api/v1/articles?category=tech&page=2" |
|
| POST |
/api/v1/articles |
Create a new article. |
title, content, tags |
curl -X POST "https://api.example.com/api/v1/articles" -H "Content-Type: application/json" -d '{"title":"New Feature","content":"Details...","tags":["release","feature"]}' |
|
| GET |
/api/v1/articles/:id |
Retrieve a single article. |
id (path) |
curl -X GET "https://api.example.com/api/v1/articles/456" |
|
| PUT |
/api/v1/articles/:id |
Update article content. |
id (path), title, content |
curl -X PUT "https://api.example.com/api/v1/articles/456" -H "Content-Type: application/json" -d '{"title":"Updated Title"}' |
|
| DELETE |
/api/v1/articles/:id |
Delete an article. |
id (path) |
curl -X DELETE "https://api.example.com/api/v1/articles/456" |
|