User Guides¶
Practical guides for apcore, from beginner to advanced.
This directory contains 7 practical guides covering the complete module development workflow. Documents are arranged by learning path; it is recommended to read the first four in order, then selectively read the rest as needed.
Document List¶
| Document | Description |
|---|---|
| creating-modules.md | Create modules from scratch, introducing multiple module definition approaches |
| schema-definition.md | Detailed Schema definition, mastering how to declare module input/output structures |
| middleware.md | Middleware development, using middleware to extend pre/post module execution logic |
| acl-configuration.md | ACL permission configuration, setting up access control rules between modules |
| testing-modules.md | Module testing strategies, covering unit tests, Schema tests, integration tests, and Mock techniques |
| adapter-development.md | Adapter development, developing apcore adapters for third-party Web frameworks |
| multi-language.md | Cross-language development, using YAML Schema to develop modules in multiple languages |
Learning Path¶
Beginner (Required Reading):
- Creating Modules -- Quick start
- Schema Definition -- Understand the core mechanism
Intermediate:
- Middleware -- Extend the execution flow
- ACL Configuration -- Security control
- Testing Modules -- Quality assurance
Specialized:
- Adapter Development -- Framework integration
- Multi-Language Development -- Cross-language collaboration
Before reading these guides, it is recommended to first understand the Core Concepts; for API details, please refer to the API Reference.