Development Roadmap

Relevant source files

• Roadmap.md

This document outlines APIJSON's development roadmap, tracking planned features, ongoing improvements, and completed enhancements across the project. The roadmap is organized into three major strategic areas: feature development, performance/security enhancements, and ecosystem growth.

For information about current system architecture and components, see System Architecture.

Roadmap Principles

All roadmap items adhere to three core principles defined in Roadmap.md:

Principle	Description
Real Use Cases	Features must address genuine application scenarios with concrete examples Roadmap.md13
Avoid Redundancy	Capabilities achievable through existing features (remote functions, @raw, etc.) are not duplicated Roadmap.md14
Backward Compatibility	New features must not break or complicate existing functionality Roadmap.md15

Sources: Roadmap.md12-16

Feature Development Timeline

APIJSON follows a continuous delivery model. Recent milestones include the addition of Common Table Expressions (WITH) and Soft Delete (Fake Delete) support.

Title: APIJSON Feature Development Timeline

Sources: Roadmap.md17-121

Planned Features

Upcoming functionality focuses on expanding SQL capability and improving developer ergonomics. For details, see Planned Features.

• Pagination Refinement: Transitioning from 0-based to 1-based indexing for page parameters by modifying DEFAULT_QUERY_PAGE and getDefaultQueryPage in Parser Roadmap.md60-65
• Distributed Queries: Implementing @url for object-level request forwarding between remote APIJSON servers, potentially using ~ for asynchronous execution Roadmap.md69-84
• Set Operations: Adding @union support (values: 0-none, 1-UNION, 2-UNION ALL) to replace INNER JOIN + OR logic with high-performance UNION queries Roadmap.md87-116
• Conditional Flexibility: Enhancing AbstractVerifier to allow PUT/DELETE operations on non-ID conditions via complex MUST syntax like "MUST":"id | date" using the pipe operator Roadmap.md176-219

Sources: Roadmap.md60-220

Performance and Security Improvements

APIJSON continues to harden its security posture and optimize query execution. For details, see Performance and Security Improvements.

Security Architecture

The security roadmap focuses on refining the multi-layered validation system:

• RBAC: Role-based access control via the Access table and @MethodAccess annotations, including planned support for deletedKey and deletedValue fields for automated soft-delete configuration Roadmap.md32-34
• Structure Validation: Using the Request table to enforce MUST, REFUSE, and TYPE constraints, with future support for AT_LEAST_ONE or ANY_ONE logic Roadmap.md181-215
• Injection Prevention: Strict use of PreparedStatement and whitelist validation in AbstractSQLConfig.

Caching Strategy

The project is moving toward a more robust two-tier caching system:

1. L1 Cache: queryResultMap within AbstractParser for object-level caching.
2. L2 Cache: cacheMap within AbstractSQLExecutor for raw SQL result caching.
3. External: Enhanced Redis integration for distributed environments Roadmap.md291-295

Sources: Roadmap.md23-34 Roadmap.md176-215 Roadmap.md291-296

Ecosystem Development

The APIJSON ecosystem aims to provide a unified experience across all major programming languages and platforms. For details, see Ecosystem Development.

Multi-Language Support

The roadmap includes stabilizing implementations for:

• Go: apijson-go
• Rust: panda-base
• Node.js: apijson-node
• PHP: hyperf-APIJSON

Tooling Integration

Further development of the "Auto" suite:

• APIAuto: Real-time machine learning-based API testing and documentation Roadmap.md8-10
• UnitAuto: Zero-code unit testing for remote functions.

Sources: Roadmap.md8-10

Implementation Map

The following diagrams bridge roadmap goals to the specific code entities responsible for their implementation.

Title: Mapping Roadmap Goals to Code Entities

Title: Soft Delete (Fake Delete) Logic Flow

Sources: Roadmap.md23-177