> For AI agents: the complete documentation index is available at https://docs.halo.run/llms.txt, the full documentation bundle is available at https://docs.halo.run/llms-full.txt.

# API 参考

## 服务端

### [自定义模型](/developer-guide/plugin/api-reference/server/extension.md)

- [定义模型](/developer-guide/plugin/api-reference/server/extension.md#person-extension-example)
- [注册模型](/developer-guide/plugin/api-reference/server/extension.md#create-extension)
- [声明预置对象](/developer-guide/plugin/api-reference/server/extension.md#declare-extension-object)
- [校验对象](/developer-guide/plugin/api-reference/server/extension.md#validate-extension-object)
- [配置索引](/developer-guide/plugin/api-reference/server/extension.md#using-indexes)
- [元数据命名](/developer-guide/plugin/api-reference/server/extension.md#元数据命名)
- [使用自动生成的 API](/developer-guide/plugin/api-reference/server/extension.md#extension-apis)
- [自定义 API](/developer-guide/plugin/api-reference/server/extension.md#custom-api-group-spec)
- [源码参考](/developer-guide/plugin/api-reference/server/extension.md#源码参考)

### [自定义 API](/developer-guide/plugin/api-reference/server/custom-endpoints.md)

- [选择 API Group](/developer-guide/plugin/api-reference/server/custom-endpoints.md#custom-api-group-spec)
- [使用 CustomEndpoint](/developer-guide/plugin/api-reference/server/custom-endpoints.md#使用-customendpoint)
- [使用带注解的控制器](/developer-guide/plugin/api-reference/server/custom-endpoints.md#使用带注解的控制器)
- [处理列表参数](/developer-guide/plugin/api-reference/server/custom-endpoints.md#处理列表参数)
- [校验请求体](/developer-guide/plugin/api-reference/server/custom-endpoints.md#using-java-bean-validation)
- [生成 OpenAPI 文档](/developer-guide/plugin/api-reference/server/custom-endpoints.md#生成-openapi-文档)
- [源码参考](/developer-guide/plugin/api-reference/server/custom-endpoints.md#源码参考)

### [编写控制器](/developer-guide/plugin/api-reference/server/reconciler.md)

- [编写 Reconciler](/developer-guide/plugin/api-reference/server/reconciler.md#编写-reconciler)
- [控制器示例](/developer-guide/plugin/api-reference/server/reconciler.md#控制器示例)

### [与自定义模型交互](/developer-guide/plugin/api-reference/server/extension-client.md)

### [获取插件配置](/developer-guide/plugin/api-reference/server/setting-fetcher.md)

- [概述](/developer-guide/plugin/api-reference/server/setting-fetcher.md#概述)
- [监听配置变更](/developer-guide/plugin/api-reference/server/setting-fetcher.md#监听配置变更)
- [使用示例](/developer-guide/plugin/api-reference/server/setting-fetcher.md#使用示例)

### [静态资源代理](/developer-guide/plugin/api-reference/server/reverseproxy.md)

### [发送和订阅通知](/developer-guide/plugin/api-reference/server/notification.md)

- [通知系统工作流程](/developer-guide/plugin/api-reference/server/notification.md#通知系统工作流程)
- [通知事件](/developer-guide/plugin/api-reference/server/notification.md#通知事件)
- [通知模板](/developer-guide/plugin/api-reference/server/notification.md#通知模板)
- [触发通知事件](/developer-guide/plugin/api-reference/server/notification.md#触发通知事件)
- [订阅通知](/developer-guide/plugin/api-reference/server/notification.md#订阅通知)
- [通知器](/developer-guide/plugin/api-reference/server/notification.md#通知器)

### [为主题提供数据](/developer-guide/plugin/api-reference/server/finder-for-theme.md)

- [创建一个 Finder](/developer-guide/plugin/api-reference/server/finder-for-theme.md#创建一个-finder)
- [Finder 命名](/developer-guide/plugin/api-reference/server/finder-for-theme.md#finder-命名)
- [使用 Finder](/developer-guide/plugin/api-reference/server/finder-for-theme.md#使用-finder)

### [在插件中提供主题模板](/developer-guide/plugin/api-reference/server/template-for-theme.md)

- [创建一个模板](/developer-guide/plugin/api-reference/server/template-for-theme.md#创建一个模板)
- [复用当前主题页面布局](/developer-guide/plugin/api-reference/server/template-for-theme.md#复用当前主题页面布局)
- [模板片段](/developer-guide/plugin/api-reference/server/template-for-theme.md#模板片段)

### [实现 WebSocket](/developer-guide/plugin/api-reference/server/websocket.md)

### [登录增强](/developer-guide/plugin/api-reference/server/login-handler-enhancer.md)

- [背景](/developer-guide/plugin/api-reference/server/login-handler-enhancer.md#背景)

### [获取扩展](/developer-guide/plugin/api-reference/server/extension-getter.md)
## UI

### [路由定义](/developer-guide/plugin/api-reference/ui/route.md)

- [定义方式](/developer-guide/plugin/api-reference/ui/route.md#定义方式)
- [类型定义](/developer-guide/plugin/api-reference/ui/route.md#类型定义)

### [API 请求](/developer-guide/plugin/api-reference/ui/api-request.md)

- [选择客户端](/developer-guide/plugin/api-reference/ui/api-request.md#选择客户端)
- [使用插件生成的 API Client](/developer-guide/plugin/api-reference/ui/api-request.md#使用插件生成的-api-client)
- [使用 Halo API Client](/developer-guide/plugin/api-reference/ui/api-request.md#使用-halo-api-client)
- [直接使用 axiosInstance](/developer-guide/plugin/api-reference/ui/api-request.md#直接使用-axiosinstance)

### [FormKit 扩展](/developer-guide/plugin/api-reference/ui/formkit.md)

- [注册输入组件](/developer-guide/plugin/api-reference/ui/formkit.md#注册输入组件)
- [在 FormKit Schema 中使用](/developer-guide/plugin/api-reference/ui/formkit.md#在-formkit-schema-中使用)
- [注意事项](/developer-guide/plugin/api-reference/ui/formkit.md#注意事项)

### [共享工具库](/developer-guide/plugin/api-reference/ui/shared.md)

- [stores](/developer-guide/plugin/api-reference/ui/shared.md#stores)
- [utils](/developer-guide/plugin/api-reference/ui/shared.md#utils)
- [events](/developer-guide/plugin/api-reference/ui/shared.md#events)

### [组件](/developer-guide/plugin/api-reference/ui/components/index.md)

- [基础组件库](/developer-guide/plugin/api-reference/ui/components/index.md#基础组件库)
- [业务组件和指令](/developer-guide/plugin/api-reference/ui/components/index.md#业务组件和指令)