API Documentation
Welcome to the Swit Framework API Documentation. Below are the available services and their API descriptions.
Available Services
SWIT Server API
This is the SWIT server API documentation.
- Endpoints: 5
- Version: 1.0
- Base URL:
http://localhost:8080/
SWIT Auth API
This is the SWIT authentication service API documentation.
- Endpoints: 5
- Version: 1.0
- Base URL:
http://localhost:8090/
Quick Links
General Information
Authentication
All API endpoints require appropriate authentication. Most endpoints use Bearer Token authentication:
http
Authorization: Bearer <your_access_token>Request Format
- Content-Type:
application/json - Accept:
application/json - Encoding: UTF-8
Error Handling
The API uses standard HTTP status codes to indicate the success or failure of requests:
| Status Code | Description | Example |
|---|---|---|
| 200 | Success | Data retrieved successfully |
| 201 | Created | User created successfully |
| 400 | Bad Request | Invalid parameter format |
| 401 | Unauthorized | Invalid or expired token |
| 403 | Forbidden | Insufficient permissions |
| 404 | Not Found | User does not exist |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | System error |
Response Format
All responses follow a unified JSON format:
json
{
"status": "success|error",
"data": {},
"message": "Response message",
"timestamp": "2023-12-01T12:00:00Z"
}