API Status: Offline
Documentation

Code Examples

Practical examples showing how to use your generated API endpoints.

Pagination

javascript
// Pagination example
fetch('https://api.restfaker.dev/api/schema/posts?page=2&perPage=10', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

Sorting

javascript
// Sorting by fields
fetch('https://api.restfaker.dev/api/schema/posts?sort=createdAt&order=desc', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));

cURL Example

bash
# cURL example
curl -X GET "https://api.restfaker.dev/api/schema/posts" \
  -H "apiToken: your_api_token_here" \
  -H "Content-Type: application/json"

Response Format

json
{
  "data": [
    {
      "id": "d9c03940-8451-4c3e-944f-6ddfd23390f6",
      "title": "Lorem ipsum dolor sit amet",
      "description": "Consectetur adipiscing elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "slug": "lorem-ipsum-dolor-sit-amet",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 50,
    "page": 1,
    "perPage": 10,
    "pages": 5
  }
}

Advanced Usage

Combining multiple query parameters:

javascript
// Advanced sorting and pagination
fetch('https://api.restfaker.dev/api/schema/posts?page=2&perPage=5&sort=createdAt&order=desc', {
  headers: {
    'apiToken': 'your_api_token_here',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => {
  console.log(`Found ${data.meta.total} posts`);
  console.log(`Showing page ${data.meta.page} of ${data.meta.pages}`);
  data.data.forEach(post => {
    console.log(`- ${post.title}`);
  });
});