Endpoint index
Find every Conduit operation by resource, HTTP method, authentication requirement, and detailed guide.
This index covers the public Conduit API in OpenAPI 3.1 contract version 2.0.0. Use https://api.realworld.show/api as the hosted demo base URL. Required means the request must include Authorization: Token <jwt>; Optional means the operation is public.
Use the linked resource guides for request bodies, parameters, response envelopes, and copyable examples. See Authentication and token usage for the header and Error envelope and HTTP status behavior for shared failure handling.
User and authentication
| Method and path | Authentication | Success | Detailed guide |
|---|---|---|---|
POST /users/login | None | 200 OK | Authenticate |
POST /users | None | 201 Created | Authenticate |
GET /user | Required | 200 OK | Read and update the current user |
PUT /user | Required | 200 OK | Read and update the current user |
Login can return 401 for invalid credentials or 422 for invalid input. Registration can return 409 for a duplicate identity or 422 for validation failures. Current-user operations can return 401 when the Token header is missing or invalid.
Profiles
| Method and path | Authentication | Success | Detailed guide |
|---|---|---|---|
GET /profiles/{username} | Optional | 200 OK | Profiles, follow, and unfollow |
POST /profiles/{username}/follow | Required | 200 OK | Profiles, follow, and unfollow |
DELETE /profiles/{username}/follow | Required | 200 OK | Profiles, follow, and unfollow |
Profile operations take the required username path parameter. Follow and unfollow can return 401, 404, or 422; profile reads can also return 401 or 404.
Articles
| Method and path | Authentication | Success | Detailed guide |
|---|---|---|---|
GET /articles | Optional | 200 OK | List and filter articles |
POST /articles | Required | 201 Created | Create an article |
GET /articles/feed | Required | 200 OK | Read the followed-user feed |
GET /articles/{slug} | None | 200 OK | Read an article by slug |
PUT /articles/{slug} | Required | 200 OK | Update an article |
DELETE /articles/{slug} | Required | 204 No Content | Delete an article |
GET /articles supports tag, author, favorited, offset, and limit. Both list operations return articles and articlesCount; read Pagination for articles and feeds before implementing page navigation. Article writes can return 401, 403, 404, 409, or 422.
Comments
| Method and path | Authentication | Success | Detailed guide |
|---|---|---|---|
GET /articles/{slug}/comments | Optional | 200 OK | List, create, and delete comments |
POST /articles/{slug}/comments | Required | 201 Created | List, create, and delete comments |
DELETE /articles/{slug}/comments/{id} | Required | 204 No Content | List, create, and delete comments |
Comment collection and creation operations use the article slug path parameter. Deletion also requires the integer comment id. The documented failure responses include 401, 403, 404, and 422 as applicable.
Favorites
| Method and path | Authentication | Success | Detailed guide |
|---|---|---|---|
POST /articles/{slug}/favorite | Required | 200 OK | Favorite and unfavorite articles |
DELETE /articles/{slug}/favorite | Required | 200 OK | Favorite and unfavorite articles |
Both operations require the article slug and return the updated article. They can return 401, 404, or 422.
Tags
| Method and path | Authentication | Success | Detailed guide |
|---|---|---|---|
GET /tags | None | 200 OK | List available tags |
The tags operation returns the tags collection and documents 422 for an invalid request.
Read the complete contract
For schemas, reusable response definitions, and the relationship between the contract and behavior tests, read OpenAPI contract and source precedence. For common response shapes, see Response envelopes and resource models.