ONES开放平台-插件开发规范

数据库设计和使用规范

• 所有表字段增加 team_id 字段。否则出现数据混乱。
• 不要创建没有主键的表；
• 库名、表名和字段名不能使用驼峰形式；
• 库名、表名、字段名中和索引名不能出现 - * \ / # @ 等字符；
• 不要向字符类型的字段插入 []byte 数据。
• 不要使用 json 类型字段。
• 不要用 NULL 值做唯一键约束。
• 使用 varchar 代替 char。
• 使用 INSERT 先显示写出要插入的列，比如不要写成 insert into values (1, 2);，而应该写为 insert into (col1, col2) values (1, 2);。
• 使用占位符的方式插入和更新数据。

接口设计规范

RESTful API 设计

RESTful API设计是一种架构风格，用于设计网络应用程序的接口。它基于HTTP协议，并利用其方法（如GET、POST、PUT、DELETE等）来操作资源。以下是设计RESTful API时的一些基本规范和最佳实践：

资源命名

• 使用名词而非动词表示资源。
• 资源名称应为复数形式，例如 /plugin/v1/users 而不是 /user。
• URL应简洁且具有可读性。

使用HTTP方法

• GET /plugin/v1/collection：获取资源列表。
• GET /plugin/v1/collection/{id}：根据ID获取特定资源。
• POST /plugin/v1/collection：创建新资源。
• PUT /plugin/v1/collection/{id}：更新特定资源（完全更新）。
• PATCH /plugin/v1/collection/{id}：部分更新特定资源。
• DELETE /plugin/v1/collection/{id}：删除特定资源。

插件注册接口地址前缀规范要求

• /plugin/v1