Skip to content

ABS Platform Documentation

API Guidelines

ovesorg/abs-platform

ABS Platform Documentation

ovesorg/abs-platform

Home
Business
Business
Models
Models
- Models Overview
- BSS (Battery Swap)
  BSS (Battery Swap)
  - Overview
  - Status
  - Business Design
    Business Design
    
    Business Logic
    
    Technical Specs
  - Workflows
    Workflows
    
    Attendant Workflow
    
    Rider Workflow
    
    Operator Workflow
    
    Asset Manager
    
    Service State
  - Integration
    Integration
    
    Odoo Mapping
    
    Odoo Billing Sync
    
    ARM IoT Sync
    
    Payment QR Flow
    
    Service Agent
  - Implementation
    Implementation
    
    Agent Enhancements
    
    Emit-Echo Pattern
    
    Setup Data Conventions
  - Testing
    Testing
    
    Scenario Tests
    
    MQTT Integration Tests
  - Configuration
    Configuration
    
    Setup Data Overview
    
    Togo Lome Market
  - Testing
    Testing
    
    Test Overview
- SNS (Swap Network Service)
  SNS (Swap Network Service)
  - Overview
  - Status
- FCS (Fast Charging Service)
  FCS (Fast Charging Service)
  - Overview
  - Status
- EPS (Electric Power Service)
  EPS (Electric Power Service)
  - Overview
  - Status
- VRS (Vehicle Rental Service)
  VRS (Vehicle Rental Service)
  - Overview
  - Status
Architecture
Architecture
Design
Design
- Entity Model
- Core Patterns
  Core Patterns
- External Integrations
  External Integrations
  - Odoo Subscription
Development
Development
- Getting Started
  Getting Started
  - Quick Start
  - Development Guide
- Technology Stack
- Guidelines
  Guidelines
- API Development
  API Development
  - API Guidelines API Guidelines
    Table of contents
    
    Coming Soon
    
    Current Resources
- Integration
  Integration
- MQTT Development
  MQTT Development
- Workflow Examples
  Workflow Examples
- Schema & Data
  Schema & Data
  - Alignment Guide
  - Semantic Constants
Archived
Archived

API Development Guidelines¶

This section will contain GraphQL resolver patterns, API design guidelines, and GraphQL development best practices.

Coming Soon¶

GraphQL Resolver Patterns
API Design Standards
Error Handling in Resolvers
Authentication and Authorization Patterns
Query Optimization Guidelines

Current Resources¶

For now, refer to the Coding Standards for general API development patterns and the Architecture documentation for system-level API design principles.