Data Model And API Map

fastbeeAbout 1 min

Data Model And API Map

1. Purpose

This page helps developers understand how business tables, APIs, and frontend pages are connected. Use it before adding fields, changing queries, or extending modules.

2. Common Table Prefixes

Prefix	Area	Notes
`iot_`	IoT product, device, thing model, logs, and runtime data.	Core business data.
`sys_`	User, role, menu, department, dictionary, and config.	System administration and permission.
`gen_`	Code generator table and column configuration.	Development tool data.
`oauth_`	OAuth client and token data.	SSO and authorization.
`notify_`	Notification channel, template, and log.	Message delivery.
`ai_`	AI providers, models, knowledge, and chat records.	AI module data.

3. Module Mapping

Business Area	Tables	API Area	Frontend Entry
Product and thing model	`iot_product`, `iot_model`, `iot_things_model`	`/iot/product`, `/iot/model`	`vue3/src/views/iot/product`
Device	`iot_device`, device log tables	`/iot/device`	`vue3/src/views/iot/device`
Rule and scene	rule and scene tables	`/rule/`, `/scene/`	`vue3/src/views/rule`, `vue3/src/views/scene`
Data center	history and report-related tables	`/datacenter/*`	`vue3/src/views/datacenter`
IoT card	card-related tables	`/card/*`	`vue3/src/views/card`
App version	app-version tables	`/appVersion/*`	`vue3/src/views/app`
AI	AI-related tables	`/ai/*`	`vue3/src/views/ai`
Generator	`gen_table`, `gen_table_column`	`/tool/gen`	`vue3/src/views/tool/gen`

4. Change Checklist

Change	Required Checks
Add field	SQL migration, entity, DTO/VO, mapper XML, frontend form, export, and permission.
Change enum	Dictionary value, frontend label, backend validation, existing data.
Change query	Data scope, tenant scope, index, pagination, and export behavior.
Change API	Frontend request file, OpenAPI docs, permission identifier, and backward compatibility.
Change time-series data	TDengine table, retention policy, aggregation, and dashboard query.

5. Development Rules

Keep database changes traceable through SQL migration files.
Do not bypass tenant and data-scope filters in business queries.
Reuse dictionaries for status fields when possible.
When adding export fields, verify both list display and export output.