Backend Module Map
About 1 min
Backend Module Map
1. Purpose
Use this page when you need to quickly locate backend code for a feature. It maps common business functions to source modules, controller directories, and API prefixes.
2. Main Source Modules
| Module | Responsibility |
|---|---|
fastbee-admin | Backend management entry and admin APIs. |
fastbee-server | Main server runtime and protocol services. |
fastbee-open-api | Open API and most business controllers. |
fastbee-ai | AI chat, providers, models, knowledge base, protocol adaptation, and NL2SQL. |
fastbee-iot-data | IoT data processing and storage support. |
fastbee-mq | Message queue integration and message processing. |
fastbee-protocol | Protocol parsing and adaptation. |
fastbee-record | Video recording and media hook handling. |
fastbee-notify | Notification channels and message delivery. |
fastbee-plugs | Optional plug-ins such as OAuth and generator. |
fastbee-common-* | Shared utilities, media, extension, and base capabilities. |
3. Feature To API Map
| Feature | Controller Area | Common Prefix |
|---|---|---|
| Product and thing model | device, protocol, runtime | /iot/product, /iot/model |
| Device management | device, gateway, deviceLog | /iot/device |
| Modbus | modbus | /modbus/* |
| Rule engine | ruleEngine, ruleview | /rule/* |
| Scene model | sceneModel | /scene/* |
| Video and SIP | media, sip | /common/player, /iot/channel |
| Data center and reports | datacenter, dashBoard | /datacenter/*, /dashboard/* |
| IoT card | card | /card/* |
| App version | appVersion | /appVersion/* |
| Code generator | tool | /tool/gen |
| OAuth/SSO | plug-in module | /oauth2/*, /sso/* |
| AI | fastbee-ai controllers | /ai/* |
4. Development Reading Order
5. Notes
- Start from the frontend API file when a page behavior is unclear.
- Check permission annotations and data-scope handling before changing queries.
- Keep API prefixes stable when extending existing modules.
- For message or protocol behavior, inspect both controller APIs and asynchronous consumers.
