BlogPosts API

v1.0 • REST • JSON

Full CRUD management for blogpost accounts. Create, retrieve, update, and delete blogpost 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/blogposts

Quick Reference

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

Get All BlogPosts

Retrieves a paginated list of all blogposts 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/blogposts/{id} 200 OK

Get Single BlogPost

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

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

BlogPost Not Found

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

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

Create BlogPost

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

Request Body
FieldTypeRequiredDescription
firstName string Required BlogPost's given name
lastName string Required BlogPost'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/blogposts/{id} 200 OK

Update BlogPost

Fully replaces an existing blogpost'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/blogposts/{id} 204 No Content

Delete BlogPost

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

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