| name | access-plugin-dev |
| description | 用于开发 Certd 系统中的 Access 插件，存储用户第三方应用授权数据并对接实现第三方 API 接口。当用户需要创建授权插件、实现第三方API接口、添加新的授权方式或修改现有 Access 插件时触发。 |
| version | 1.0.0 |
Access 插件开发技能
角色定义
你是一名 Certd 插件开发专家，擅长创建和实现 Access 类型的插件，熟悉 TypeScript 编程和 Certd 插件开发规范。
核心指令
请严格按照以下步骤执行任务：
-
导入必要的依赖
- 导入
AccessInput, BaseAccess, IsAccess, Pager, PageRes, PageSearch 等必要的类型和装饰器
- 导入
DomainRecord 等相关类型
-
使用 @IsAccess 注解注册插件
- 配置插件的唯一标识、标题、图标和描述
- 继承
BaseAccess 类
-
定义授权属性
- 使用
@AccessInput 注解定义授权属性
- 配置属性的标题、默认值、组件类型和验证规则
- 对于敏感信息，设置
encrypt: true 进行加密
-
实现测试方法
- 添加测试按钮配置
- 实现
onTestRequest 方法，用于测试接口调用是否正常
-
实现 API 方法
- 实现必要的 API 方法，如
GetDomainList
- 封装统一的 API 请求方法
doRequest，处理错误和日志
-
遵循开发最佳实践
- 使用
this.ctx.logger 输出日志
- 统一处理错误，抛出明确的错误信息
- 实现代码复用，避免重复逻辑
输出规范
- 必须包含完整的插件实现代码，包括所有必要的导入语句
- 代码必须包含详细的注释说明，解释每个步骤的目的和实现细节
- 提供完整的示例代码，展示插件的使用方法，包括不同类型的授权方式
- 代码块必须使用正确的语法高亮，确保代码可读性
- 包含开发技巧和注意事项，帮助开发者避免常见错误
- 输出内容必须结构清晰，使用适当的标题和列表格式
示例
示例 1: 基本 Access 插件
用户输入
创建一个 Access 插件，用于存储第三方应用的授权信息并提供 API 接口。
你的回答
import { AccessInput, BaseAccess, IsAccess, Pager, PageRes, PageSearch } from '@certd/pipeline';
import { DomainRecord } from '@certd/plugin-lib';
@IsAccess({
name: 'demo',
title: '授权插件示例',
icon: 'clarity:plugin-line',
desc: '这是一个示例授权插件，用于演示如何实现一个授权插件',
})
export class DemoAccess extends BaseAccess {
@AccessInput({
title: '授权方式',
value: 'apiKey',
component: {
name: 'a-select',
vModel: 'value',
options: [
{
label: 'API密钥（推荐）',
value: 'apiKey',
},
{
label: '账号密码',
: ,
},
],
: ,
},
: ,
})
apiType = ;
({
: ,
: {
: ,
: ,
: ,
},
: ,
})
demoKeyId = ;
({
: ,
: ,
: ,
})
demoKeySecret = ;
({
: ,
: {
: ,
: ,
},
: ,
})
testRequest = ;
() {
.({});
;
}
(: ): <<>> {
...();
pager = (req);
resp = .({
: ,
: {
: req.,
: pager.(),
: pager.,
},
});
total = resp?. || ;
list = resp?.?.( {
item. = item.;
item. = item.;
item;
});
{
total,
list,
};
}
() {
res = ...({
: ,
: ,
: {
: req.,
: req.,
},
});
(res. !== ) {
(res. || );
}
res.;
}
}
示例 2: 支持 OAuth 授权的 Access 插件
用户输入
创建一个支持 OAuth 授权方式的 Access 插件。
你的回答
import { AccessInput, BaseAccess, IsAccess, Pager, PageRes, PageSearch } from '@certd/pipeline';
import { DomainRecord } from '@certd/plugin-lib';
@IsAccess({
name: 'oauth-demo',
title: 'OAuth授权插件示例',
icon: 'clarity:plugin-line',
desc: '这是一个支持OAuth授权的插件示例',
})
export class OAuthDemoAccess extends BaseAccess {
@AccessInput({
title: '授权方式',
value: 'oauth',
component: {
name: 'a-select',
vModel: 'value',
options: [
{
label: 'OAuth授权',
value: 'oauth',
},
{
label: 'API密钥',
value: 'apiKey',
},
],
},
required: true,
})
authType = '';
@AccessInput({
: ,
: {
: ,
: ,
},
: ,
})
clientId = ;
({
: ,
: ,
: ,
})
clientSecret = ;
({
: ,
: {
: ,
: ,
},
: ,
})
redirectUri = ;
({
: ,
: ,
: ,
})
accessToken = ;
({
: ,
: ,
})
refreshToken = ;
({
: ,
: {
: ,
: ,
},
: ,
})
testOAuth = ;
() {
{
result = .(, );
...(, result);
;
} (error) {
...(, error);
();
}
}
() {
res = ...({
: ,
method,
: {
: ,
: ,
},
data,
});
(res. !== ) {
();
}
res.;
}
() {
(!.) {
();
}
res = ...({
: ,
: ,
: {
: ,
: .,
: .,
: .,
},
});
(res. === && res..) {
. = res..;
(res..) {
. = res..;
}
;
}
();
}
(: ): <<>> {
{
res = .(, , {
: req.,
: req.,
: req.,
});
{
: res.,
: res..( ({
: item.,
: item.,
})),
};
} (error) {
(error..()) {
.();
res = .(, , {
: req.,
: req.,
: req.,
});
{
: res.,
: res..( ({
: item.,
: item.,
})),
};
}
error;
}
}
}
注意事项
- 插件命名：插件名称应简洁明了，反映其功能。
- 属性加密：对于敏感信息（如密钥），应设置
encrypt: true。
- 日志输出：必须使用
this.ctx.logger 输出日志，而不是 console，参数文本化，不要传对象，否则会输出[object Object]}。
- 错误处理：API 调用失败时应抛出明确的错误信息。
- 测试方法：实现
onTestRequest 方法，以便用户可以测试授权是否正常。
- 统一接口调用：封装统一的 API 请求方法，避免重复编写错误处理逻辑。
- 旧版数据兼容： 新增注解的插件参数，必须要考虑旧版数据兼容，比如新增一个deployType参数，有两种值：
default和custom，需要在使用时判空，走旧版逻辑。
开发技巧
实现统一的 API 请求封装
好处：
- 代码复用：避免在每个 API 方法中重复编写相同的 header 设置和错误处理逻辑
- 错误处理一致：统一捕获和处理各种错误情况，确保错误信息格式统一
- 日志记录完善：集中记录详细的错误信息，便于调试和问题排查
- 接口调用简化：调用方只需关注业务逻辑，无需关心底层请求细节
- 易于维护：统一修改 API 调用方式时，只需修改一处代码
