Skip to main content

API Documentation

WillAbout 3 minUser Guide

Overview

QiLuo is an enterprise-level rapid development platform based on the Rust technology stack, using the Axum framework to build high-performance Web API services. This document provides detailed information about the design and functionality of each API interface module in the QiLuo system.

File location: mod.rs

System Architecture Design

Route Structure

The QiLuo system adopts a modular route design, primarily divided into two categories:

  • Protected Routes: Business interfaces requiring authentication and permission verification
  • Public Routes: Public interfaces that do not require authentication (such as login, verification code, etc.)

WebPath Design Pattern

The system uses a custom WebPath structure to manage routes, which provides the following advantages:

  • Unified permission control mechanism
  • Automatic API documentation generation support
  • Structured API description information

Core Business Modules

1. User Management Module (/sys/user)

The user management module provides complete user lifecycle management functionality:

Core Features:

  • User information query and management
  • Paginated user list query
  • User addition, editing, and deletion operations
  • Password management (reset, modification)
  • Avatar update functionality
  • User department and role association management
  • JWT token refresh mechanism
  • User logout

2. Menu Management Module (/sys/menu)

The menu management module is responsible for the system's navigation structure and permission control:

Core Features:

  • Retrieval of all route information
  • Menu list query
  • Menu tree structure construction
  • Menu addition, deletion, and modification operations

3. Department Management Module (/sys/dept)

The department management module provides organizational structure management functionality:

Core Features:

  • Tree-structured department list display
  • Department tree structure query
  • Department information maintenance
  • User-department association query

4. Role Permission Module (/sys/role & /sys/roleapi)

The role permission module implements Role-Based Access Control (RBAC):

Role Management Features:

  • Role list query
  • Role menu permission configuration
  • Role department data permissions
  • Role tree structure display
  • Role addition, deletion, and modification operations

Role API Permission Features:

  • Role API permission list management
  • Batch permission assignment
  • Permission transfer list query
  • Role permission list retrieval

5. System Monitoring Module

Login Information Monitoring (/sys/logininfo)

  • User login log query

Online User Management (/sys/useronline)

  • Online user list query
  • Force user offline functionality

Server Information (/sys/serverinfo)

  • Server status update interface

6. Data Dictionary Module

Dictionary Data Management (/sys/dictdata)

  • Complete CRUD operations for dictionary data
  • Dictionary data query by type

Dictionary Type Management (/sys/dicttype)

  • Dictionary type management and maintenance

7. Scheduled Task Module

Task Management (/sys/job)

  • Complete lifecycle management of scheduled tasks
  • Cron expression validation
  • Manual task execution functionality

Task Logs (/sys/jobinfo)

  • Task execution log recording and query

8. Permission Management Module (/sys/apipermission)

  • API permission list management
  • Permission configuration editing

9. Dashboard Module (/sys/dashboard)

Provides rich data visualization interfaces:

Data Analysis Dashboard (/analysis)

  • Overall data statistics
  • User access source analysis
  • User activity weekly report
  • Monthly sales data

Workbench Dashboard (/workplace)

  • Workbench overview data
  • Project statistics
  • Dynamic information display
  • Team data display
  • Radar chart data analysis

10. System Log Module (/sys/operationlog)

  • Operation log recording and query

11. Cache Management Module (/sys/cache)

  • Cache list query
  • Cache cleaning operations

Public Interface Module

Authentication Interface (/sys/auth)

  • User login interface
  • Verification code acquisition interface

Test Interface (/sys/test)

  • System test-related interfaces

Technical Features

1. RESTful API Design

The system strictly follows RESTful API design specifications, using standard HTTP methods:

  • GET: Query operations
  • POST: Create operations
  • PUT: Update operations
  • DELETE: Delete operations

2. Unified Response Format

All API interfaces adopt a unified response format, ensuring consistency in front-end and back-end interactions.

3. Permission Control

  • JWT-based authentication
  • Fine-grained API permission control
  • Role-Based Access Control (RBAC)

4. High-Performance Design

  • Asynchronous processing based on the Axum framework
  • Support for high-concurrency access
  • Optimized database queries

Deployment Features

QiLuo system API supports:

  • Cluster Deployment: Supports multiple instance load balancing
  • Multiple Data Sources: Supports multiple database connections
  • Distributed Deployment: Supports microservice architecture deployment
  • Containerized Deployment: Supports Docker and Kubernetes deployment

Scalability

The system adopts a modular design, with relatively independent functional modules, facilitating:

  • Independent development and testing of functional modules
  • Progressive extension of system functionality
  • Integration and connection with third-party systems

The QiLuo system API interface design fully considers the needs of enterprise-level applications, providing complete backend management functionality, establishing a solid foundation for rapidly building enterprise-level applications.