Comments API

v1.0 • REST • JSON

Full CRUD management for comment accounts. Create, retrieve, update, and delete comment records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints Auth Required
Base URL https://bogusapi.com/api/comments

Quick Reference

GET
/api/comments List all comments (paginated)
200 GET
/api/comments/{id} Get one comment by ID
200 POST
/api/comments Create a new comment
201 PUT
/api/comments/{id} Replace comment data
204 DEL
/api/comments/{id} Remove a comment
204 GET
/api/comments/{id} Comment not found example
404
GET /api/comments 200 OK

Get All Comments

Retrieves a paginated list of all comments in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/comments/{id} 200 OK

Get Single Comment

Fetch the full profile for a specific comment using their numeric ID. Returns all comment fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique comment identifier
Response: 200 OK
GET /api/comments/{id} 404 Not Found

Comment Not Found

Returned when the requested comment ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing comment resources.

Response: 404 Not Found 
{}
POST /api/comments 201 Created

Create Comment

Registers a new comment with the provided details. On success, returns the newly created comment object — including the auto-generated ID, timestamp, and resolved role names.

Request Body
FieldTypeRequiredDescription
firstName string Required Comment's given name
lastName string Required Comment's family name
email string Required Unique email address
password string Required Plaintext password for the account
roleIds integer[] Optional IDs of roles to assign on creation
Body
Response: 201 Created
PUT /api/comments/{id} 200 OK

Update Comment

Fully replaces an existing comment's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
FieldTypeRequiredDescription
firstName string Required Updated first name
lastName string Required Updated last name
email string Required Updated email address
roleIds integer[] Optional New role assignment (replaces existing)
Body
Response: 200 OK
DELETE /api/comments/{id} 204 No Content

Delete Comment

Permanently removes a comment from the system by their ID. This action is irreversible — once deleted, the comment record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the comment to delete
Response: 204 No Content 
{}