File tree 10 files changed +1070
-300
lines changed
versioned_docs/version-2.20/developer-guide
10 files changed +1070
-300
lines changed Original file line number Diff line number Diff line change 36
36
37
37
字段说明:
38
38
39
- 1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#metadata-name),为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
39
+ 1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#naming-spec-for- metadata-name),为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
40
40
2. `spec.targetRef`:模型的关联,即为哪个模型添加元数据表单,目前支持的模型可查看下方的列表。
41
41
3. `spec.formSchema`:表单的定义,使用 FormKit Schema 来定义。虽然我们使用的 YAML,但与 FormKit Schema 完全一致。
42
42
Original file line number Diff line number Diff line change @@ -100,7 +100,7 @@ public PersonService {
100
100
101
101
我们建议你更多的使用响应式的 ` ReactiveExtensionClient ` 去替代 ` ExtensionClient ` 。
102
102
103
- ### 查询
103
+ ### 查询 {#query}
104
104
105
105
` ReactiveExtensionClient ` 提供了两个方法用于查询数据,` listBy ` 和 ` listAll ` 。
106
106
Load Diff Large diffs are not rendered by default.
Original file line number Diff line number Diff line change @@ -215,7 +215,7 @@ API client 是一种工具或库,旨在简化前端应用程序与后端服务
215
215
216
216
- 提高开发效率:通过使用 API 客户端,开发者可以专注于业务逻辑的实现,而不用关心底层的 HTTP 细节。这不仅提高了开发效率,还减少了代码冗余。
217
217
218
- #### 如何生成 API client
218
+ #### 如何生成 API client {#how-to-generate-api-client}
219
219
220
220
本插件提供了一个 ` generateApiClient ` 任务,用于为插件项目生成 API client,生成规则基于 OpenAPI 规范来自动生成客户端代码。
221
221
Original file line number Diff line number Diff line change @@ -131,7 +131,7 @@ rules:
131
131
132
132
1. 定义了一个用于管理 Person 自定义模型对象的角色模板 `my-plugin-role-manage-persons`,它具有所有权限。
133
133
2. 定义了一个只允许查询 Person 资源的角色模板 `my-plugin-role-view-persons`。
134
- 3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#metadata-name)。
134
+ 3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#naming-spec-for- metadata-name)。
135
135
136
136
下面让我们回顾一下这些配置:
137
137
Original file line number Diff line number Diff line change 36
36
37
37
字段说明:
38
38
39
- 1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#metadata-name) ,为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
39
+ 1. `metadata.name`:唯一标识,命名规范可参考 [metadata name](./plugin/api-reference/server/extension.md#naming-spec-for- metadata-name,为了尽可能避免冲突,建议自定义前缀以及追加随机字符串,如:`theme-earth-post-wanfs5`。
40
40
2. `spec.targetRef`:模型的关联,即为哪个模型添加元数据表单,目前支持的模型可查看下方的列表。
41
41
3. `spec.formSchema`:表单的定义,使用 FormKit Schema 来定义。虽然我们使用的 YAML,但与 FormKit Schema 完全一致。
42
42
Original file line number Diff line number Diff line change @@ -100,7 +100,7 @@ public PersonService {
100
100
101
101
我们建议你更多的使用响应式的 ` ReactiveExtensionClient ` 去替代 ` ExtensionClient ` 。
102
102
103
- ### 查询
103
+ ### 查询 {#query}
104
104
105
105
` ReactiveExtensionClient ` 提供了两个方法用于查询数据,` listBy ` 和 ` listAll ` 。
106
106
Load Diff Large diffs are not rendered by default.
Original file line number Diff line number Diff line change @@ -34,11 +34,11 @@ plugins {
34
34
35
35
``` shell
36
36
=======================================================================
37
- > Halo 启动成功!
38
- 访问地址:http://localhost:8090/console? language=zh-CN
39
- 用户名:admin
40
- 密码:admin
41
- API 文档:http://localhost:8090/swagger-ui.html
37
+ > Halo 启动成功!
38
+ 访问地址:http://localhost:8090/console? language=zh-CN
39
+ 用户名:admin
40
+ 密码:admin
41
+ API 文档:http://localhost:8090/swagger-ui.html
42
42
插件开发文档:https://docs.halo.run/developer-guide/plugin/introduction
43
43
=======================================================================
44
44
```
@@ -117,8 +117,8 @@ halo {
117
117
``` yaml
118
118
# workplace/config/application.yaml
119
119
logging :
120
- level :
121
- run.halo.app : DEBUG
120
+ level :
121
+ run.halo.app : DEBUG
122
122
` ` `
123
123
124
124
更多配置项请参考 [Halo 配置列表](../../../getting-started/install/config.md#配置列表)。
@@ -215,7 +215,7 @@ API client 是一种工具或库,旨在简化前端应用程序与后端服务
215
215
216
216
- 提高开发效率:通过使用 API 客户端,开发者可以专注于业务逻辑的实现,而不用关心底层的 HTTP 细节。这不仅提高了开发效率,还减少了代码冗余。
217
217
218
- #### 如何生成 API client
218
+ #### 如何生成 API client {#how-to-generate-api-client}
219
219
220
220
本插件提供了一个 ` generateApiClient ` 任务,用于为插件项目生成 API client,生成规则基于 OpenAPI 规范来自动生成客户端代码。
221
221
@@ -421,5 +421,5 @@ halo {
421
421
422
422
``` shell
423
423
# 如将 Gradle 版本升级至 8.9
424
- ./gradlew wrapper --gradle-version=8.9
424
+ ./gradlew wrapper --gradle-version=8.9
425
425
```
Original file line number Diff line number Diff line change @@ -131,7 +131,7 @@ rules:
131
131
132
132
1. 定义了一个用于管理 Person 自定义模型对象的角色模板 `my-plugin-role-manage-persons`,它具有所有权限。
133
133
2. 定义了一个只允许查询 Person 资源的角色模板 `my-plugin-role-view-persons`。
134
- 3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#metadata-name)。
134
+ 3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#naming-spec-for- metadata-name)。
135
135
136
136
下面让我们回顾一下这些配置:
137
137
You can’t perform that action at this time.
0 commit comments