Policy reference

This section details MakerKit's API, providing examples of GET and POST requests, along with their payloads and responses. To effectively test these requests, consider creating a simple component. This component can handle sending requests to the API endpoints and displaying the results.

Example Component (Conceptual):

This is a conceptual example and the specific implementation will depend on your chosen framework (React, Vue, etc.).

// Example using fetch API (adjust for your framework)
async function makeApiRequest(method, url, payload) {
  const response = await fetch(url, {
    method: method,
    headers: {
      'Content-Type': 'application/json'
    },
    body: payload ? JSON.stringify(payload) : null
  });

  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }

  return await response.json();
}

// Example GET request
async function getExample() {
  try {
    const data = await makeApiRequest('GET', '/api/example');
    console.log('GET Response:', data);
  } catch (error) {
    console.error('GET Error:', error);
  }
}

// Example POST request
async function postExample() {
  const payload = { key1: 'value1', key2: 'value2' };
  try {
    const data = await makeApiRequest('POST', '/api/example', payload);
    console.log('POST Response:', data);
  } catch (error) {
    console.error('POST Error:', error);
  }
}

// Call the functions to test
getExample();
postExample();

API Endpoint Examples:

(Replace /api/example with your actual API endpoints)

• GET /api/example: Retrieves example data.

  • Response (Example):

  {
    "message": "Success",
    "data": [
      { "id": 1, "name": "Item 1" },
      { "id": 2, "name": "Item 2" }
    ]
  }
  

• POST /api/example: Creates a new example item.

  • Request Payload (Example):

  {
    "name": "New Item"
  }
  

  • Response (Example):

  {
    "message": "Item created successfully",
    "id": 3
  }
  

Remember to replace the placeholder API endpoints and data with your actual API specifications. This component structure provides a foundation for testing various API requests and examining the payloads and responses. Adapt and expand upon this example to suit your specific needs and testing requirements.