2. 由于自动生成的 APIs 不能覆盖,因此通过不同的 group 来区分,自定义的 APIs 的 group 建议遵循以下规则:
2. 为了与自动生成的 CRUD APIs 区分开避免冲突,我们选择通过不同的 group 来区分,自定义 APIs 的 group 建议遵循以下规则,以便保证唯一性的同时能与自定义模型产生关联:
- 在 Console 端使用的自定义 APIs 的 group 规则 `console.api.<group>`,例如对于 Person 自定义模型需要一个一个在 Console 端使用的自定义 API 的 group 为 `console.api.my-plugin.halo.run`。
- 在个人中心使用的自定义 APIs 的 group 规则 `uc.api.<group>`,例如 `uc.api.my-plugin.halo.run`。
- 为主题端提供的公开的自定义 APIs 的 group 规则 `api.<group>`,例如 `api.my-plugin.halo.run`。
- 在 Console 端使用的自定义 APIs 的 group 规则建议为`console.api.<group>`,例如对于 Person 自定义模型需要额外的在 Console 端使用的自定义 APIs 那么 group 可以定义为 `console.api.my-plugin.halo.run`,则可能的用于查询 Person 列表的 API 的规则应为 `/apis/console.api.my-plugin.halo.run/v1alpha1/persons`。
- 在个人中心使用的自定义 APIs 的 group 规则建议为`uc.api.<group>`,例如 `uc.api.my-plugin.halo.run`。
- 为主题端提供的公开的自定义 APIs 的 group 规则建议为`api.<group>`,例如 `api.my-plugin.halo.run`。