Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.serial.okos.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction to SerialRequestHandler

At the core of the Serial API’s request handling system lies the SerialRequestHandler class. This abstract class serves as a foundational template for processing API requests, providing a structured approach to authentication, validation, and action execution.

​
Key Components of SerialRequestHandler

​
1. Authentication and Privileges

The class begins by determining the authentication type: 
export enum AuthType {
  Jwt = "JWT",
  ApiKey = "API_KEY",
  SuperApiKey = "SUPER_API_KEY",
}
It then establishes the user’s privileges based on this authentication, setting up the groundwork for subsequent operations.

​
2. Abstract Methods

SerialRequestHandler defines four crucial abstract methods that must be implemented by its subclasses:
  • getRelevantData: Retrieves necessary data for the request.
  • validatePrivileges: Ensures the user has appropriate permissions.
  • validateRequest: Checks the validity of the request parameters.
  • performAction: Executes the main logic of the request.

​
3. Request Processing Flow

The main handleRequest method orchestrates the request processing:
  1. Checks content length
  2. Parses the request body
  3. Retrieves relevant data
  4. Validates privileges
  5. Validates the request
  6. Performs the action
  7. Handles errors and generates appropriate responses

​
Extending SerialRequestHandler

Various specific handler classes extend SerialRequestHandler, each tailored to a particular API endpoint. For example: 
class CreateComponent extends SerialRequestHandler {
  static className = "CreateComponent";
  // ... implementation of abstract methods
}
These subclasses implement the abstract methods according to their specific requirements, maintaining a consistent structure across different endpoints.

​
Key Features

  1. Telemetry: The class includes optional telemetry recording for performance monitoring.
  2. Error Handling: Comprehensive error catching and response generation for various scenarios.
  3. Flexibility: Supports different authentication types and can be easily extended for new endpoints.
  4. Validation: Built-in methods for validating both user privileges and request parameters.
  5. Data Retrieval: The getRelevantData method allows efficient fetching of necessary information before processing.

​
Conclusion

The SerialRequestHandler class provides a robust and flexible foundation for handling API requests in the Serial API. By enforcing a consistent structure and flow across different endpoints, it ensures maintainability, security, and efficiency in request processing. Developers can easily extend this class to create new endpoint handlers while adhering to established patterns and best practices.