doc.md

API Documentation

Table of Contents

• Auth Signup
• Auth Login

Admin Endpoint

• Admin Login

Auth Signup

Endpoint: /api/endpoint-1 Method: GET

Description of what this endpoint does.

Request

• Parameters:
  • param1: Description of param1.
  • param2: Description of param2.

Response

• Status Code: 200 OK
• Response Body:

  {
    "key": "value"
  }

Auth Login

Endpoint: /api/endpoint-2 Method: POST

Description of what this endpoint does.

Request

• Parameters:
  • param1: Description of param1.
• Request Body:

  {
    "key": "value"
  }

Response

• Status Code: 201 Created

Admin Login

Endpoint: /api/endpoint-3 Method: PUT

Description of what this endpoint does.

Request

• Parameters:
  • param1: Description of param1.
• Request Body:

  {
    "key": "new-value"
  }

Response

• Status Code: 200 OK