logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo

Quick Start

Plugin Development Overview
Write Your First Plugin
Project Structure

Server Development

Overview
Plugin
Collections
Database
DataSourceManager
ResourceManager
ACL
Middleware
Cache
Event
Context
Migration
Logger
I18n
Command
CronJobManager
Test

Client Development

Overview
Plugin
Context
Router
ACL
DataSourceManager
Resource
Request
Styles & Themes
Logger
I18n
Test

Others

Plugin Upgrade Guide
Languages
Dependency Management
Build
Next PagePlugin Development Overview

#Overview

NocoBase server-side plugin development provides various functionalities and capabilities to help developers customize and extend NocoBase's core features. The following are the main capabilities and related chapters of NocoBase server-side plugin development:

ModuleDescriptionRelated Chapter
Plugin ClassCreate and manage server-side plugins, extend core functionalityplugin.md
Database OperationsProvides interfaces for database operations, supporting CRUD and transaction managementdatabase.md
Custom CollectionsCustomize collection structures based on business needs for flexible data model managementcollections.md
Plugin Upgrade Data CompatibilityEnsures plugin upgrades do not affect existing data by performing data migration and compatibility handlingmigration.md
External Data Source ManagementIntegrate and manage external data sources to enable data interactiondata-source-manager.md
Custom APIsExtend API resource management by writing custom interfacesresource-manager.md
API Permission ManagementCustomize API permissions for fine-grained access controlacl.md
Request/Response Interception and FilteringAdd request and response interceptors or middleware to handle tasks like logging, authentication, etc.context.md and middleware.md
Event ListeningListen to system events (e.g., from the application or database) and trigger corresponding handlersevent.md
Cache ManagementManage the cache to improve application performance and response speedcache.md
Scheduled TasksCreate and manage scheduled tasks, such as periodic cleanup, data synchronization, etc.cron-job-manager.md
Multi-language SupportIntegrate multi-language support to implement internationalization and localizationi18n.md
Log OutputCustomize log formats and output methods to enhance debugging and monitoring capabilitieslogger.md
Custom CommandsExtend the NocoBase CLI by adding custom commandscommand.md
Writing Test CasesWrite and run test cases to ensure plugin stability and functional accuracytest.md