Walkthrough DASH SAAS

Creating a comprehensive API documentation walkthrough involves outlining the essential components needed for developers to understand and use the API effectively. Here's a structured approach to documenting an API, focusing on the Base Model and Base URL, and expanding to include other key sections typically found in API documentation.

API Documentation Walkthrough

1. Introduction

Welcome to the DASH SAAS API Documentation!

This document provides all the necessary information to start working with the DASH SAAS API, including endpoints, request/response formats, and examples.

2. Base URL

The Base URL is the root URL for all API requests. Each endpoint will be appended to this base URL.

Base URL:

https://service-dash.dlabssaas.io

All API requests should be made to this base URL.

3. Authentication

Authentication Method:
The API uses token-based authentication. You will need to include an API key in the headers of your requests.

Header Example:

Authorization: Bearer YOUR_API_KEY

4. Standard API Mapping

This documentation provides an overview of the API endpoints and their respective HTTP methods, which follow standard RESTful principles. The API allows clients to perform CRUD (Create, Read, Update, Delete) operations on resources. Below are the standard mappings and descriptions for each operation:

1. POST Method - Insert Data

Purpose: Used to create a new resource.

Endpoint: /api/resource

Description: This endpoint accepts a JSON payload representing the new resource to be created. Upon successful creation, it returns the details of the newly created resource along with a status code indicating success.

Example Request:

2. GET Method - Retrieve Data

Purpose: Used to retrieve existing resources.

Endpoint: /api/resource or /api/resource/{id}

Description: This endpoint can be used to fetch a list of all resources or a specific resource by its ID. The response includes the requested data and a status code indicating success.

Example Request:

3. PUT Method - Update Data

Purpose: Used to update an existing resource.

Endpoint: /api/resource/{id}

Description: This endpoint accepts a JSON payload with updated information for an existing resource specified by its ID. It returns the updated resource details and a status code indicating success upon completion.

Example Request:

4. DELETE Method - Delete Data

Purpose: Used to delete an existing resource.

Endpoint: /api/resource/{id}

Description: This endpoint deletes the resource specified by its ID. It returns a status code indicating success upon successful deletion.

Example Request:

Headers

Headers:

Content-Type: Should be application/json for endpoints that accept a payload.

Authorization: Depending on your setup, this may be required for authentication.

Please consider whether our standard mapping has not been implemented yet or does not match our standard documentation mapping.

5. Base Model

The Base Model section defines the common structure used in the API responses. Understanding the base model helps in interpreting the data returned by various endpoints.

Example Base Model:

{
  "status": "success",
  "data": dynamic object,
  "info": {
        "id": "",
        "message": "",
        "messageEn": null,
        "messageId": null,
        "field": null,
        "redirect": null
    }
}

status: Indicates the success or failure of the request.

data: Contains the primary response data (dynamic objecy).

info: Contains about info the response.

6. Error Handling

API responses include error messages in a consistent format.

Error Response Example:

{
    "status": "error",
    "data": null,
    "info": {
        "id": "SYSTEM_ERROR",
        "message": "Error Message",
        "messageEn": null,
        "messageId": null,
        "field": null,
        "redirect": null
    }
}

7. Pagination

If an endpoint supports pagination, the response will include pagination details in the meta object.

Pagination Parameters:

page[number]: Page number to retrieve.

page[size]: Number of items per page.

Request Example:

GET https://api.example.com/v1/users?page[number]=2&page[size]=10
Headers:
  Authorization: Bearer YOUR_API_KEY

Response:

{
  "data": {
    "content": [
      {
        // dynamic data response 
      }
    ],
    "empty": true,
    "first": true,
    "last": true,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
      "offset": 0,
      "pageNumber": 0,
      "pageSize": 0,
      "paged": true,
      "sort": {
        "empty": true,
        "sorted": true,
        "unsorted": true
      },
      "unpaged": true
    },
    "size": 0,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "totalElements": 0,
    "totalPages": 0
  },
  "info": {
    "field": "string",
    "id": "string",
    "message": "string",
    "messageEn": "string",
    "messageId": "string",
    "redirect": "string"
  },
  "status": "string"
}

8. Conclusion

For more detailed information on each endpoint and to explore additional functionalities, please refer to the full API reference.

Contact Support:
If you encounter any issues or have questions, please contact our backend team

Walkthrough DASH SAAS

API Documentation Walkthrough#

1. Introduction#

2. Base URL#

3. Authentication#

4. Standard API Mapping#

1. POST Method - Insert Data#

2. GET Method - Retrieve Data#

3. PUT Method - Update Data#

4. DELETE Method - Delete Data#

Headers#

5. Base Model#

6. Error Handling#

7. Pagination#

8. Conclusion#

API Documentation Walkthrough

1. Introduction

2. Base URL

3. Authentication

4. Standard API Mapping

1. POST Method - Insert Data

2. GET Method - Retrieve Data

3. PUT Method - Update Data

4. DELETE Method - Delete Data

Headers

5. Base Model

6. Error Handling

7. Pagination

8. Conclusion