包含 REST API / Dubbo Service / MyBatis Mapper 全量方法签名
| # | 类型 | 方法签名 / URL | 入参 (中文说明) | 出参 (中文说明) | 评级 | 优先级 | 业务域 |
|---|---|---|---|---|---|---|---|
| 1 | POST | /oauth/token | grant_type(授权方式:password/client_credentials), client_id(客户端ID), client_secret(客户端密钥), username(用户名), password(密码), scope(权限范围) | access_token(JWT访问令牌), token_type(Bearer), expires_in(有效期秒数, 默认3600), refresh_token(刷新令牌), scope(实际授权范围) | A | P0 | 认证授权 |
| 2 | POST | /oauth/revoke | token(要撤销的令牌字符串) | result_code(结果码: 000000成功), message(提示消息) | A | P0 | 认证授权 |
| 3 | GET | /oauth/check_token | token(要验证的令牌) | active(boolean: 是否有效), scope(权限范围列表), client_id(客户端ID), exp(过期时间戳UNIX), userName(用户名) | A | P0 | 认证授权 |
| 4 | POST | dubbo: FopAuthService.authenticate() | username(登录用户名), password(登录密码), loginType(登录方式: password/sms/ldap), clientId(客户端标识) | AuthResult: token(JWT令牌), userInfo(UserDTO: userId/userName/realName/company), permissions(String[]: 权限码列表), roles(String[]: 角色列表) | A | P0 | 认证授权 |
| 5 | POST | dubbo: FopAuthService.refreshToken() | oldToken(即将过期的JWT令牌) | TokenResult: newToken(新JWT令牌), expiresIn(新令牌有效秒数), tokenType(Bearer) | A | P0 | 认证授权 |
| 6 | GET | /auth/permissions | accessToken(当前有效的访问令牌, 放在Header Authorization中) | permissions(List<String>: 权限码如 api:read, app:create), roles(List<String>: 角色名如 admin, developer) | A | P0 | 认证授权 |
| 7 | POST | /api/apps | appName(应用名称, 必填, 2-50字符), appType(应用类型: 1自建应用/2第三方应用), callbackUrl(回调URL, OAuth回调地址), description(应用描述, 最大500字符), iconUrl(应用图标URL, 可选) | AppCreateResult: appId(系统生成的应用ID, Long类型), appCode(唯一应用编码, 自动生成), appKey(API调用密钥, 用于请求签名), appSecret(API密钥对应的Secret, 仅返回一次需立即保存) | A | P0 | 应用管理 |
| 8 | PUT | /api/apps/{id} | id(路径参数, 应用ID), appName(更新的应用名称), description(更新的描述), callbackUrl(更新的回调地址), iconUrl(更新的图标URL) | ResultDTO: code(结果码), message(提示消息), data(null或更新后的时间戳) | A | P0 | 应用管理 |
| 9 | GET | /api/apps/{id} | id(路径参数, 要查询的应用ID) | AppDetailVO: appId, appCode, appName, appType, status(当前状态码), appKey, callbackUrl, description, createTime, updateTime, subscribeList(已订阅的API列表, 含API名称和订阅状态) | A | P0 | 应用管理 |
| 10 | GET | /api/apps | status(可选, 按状态筛选: 0草稿/1待审/2已审/3冻结), keyword(可选, 名称模糊搜索), pageNo(页码, 默认1), pageSize(每页条数, 默认20) | PageResult<AppInfoVO>: list(应用信息列表), totalCount(总记录数), pageNum(当前页), pageSize(每页大小) | A | P0 | 应用管理 |
| 11 | POST | /api/apps/{id}/submit | id(路径参数, 应用ID) | SubmitResult: result_code, message, applyId(生成的审核申请单ID, 用于追踪审核进度) | A | P0 | 应用管理 |
| 12 | POST | /api/apis | apiName(API名称, 必填), apiPath(API请求路径, 如/api/v1/user/info), httpMethod(HTTP方法: GET/POST/PUT/DELETE), apiCategory(API分类: 1数据查询/2数据写入/3文件操作/4支付相关), description(API功能描述), requestParams(JSON格式的请求参数说明), responseFormat(JSON格式的响应格式说明) | ApiCreateResult: apiId(生成的API ID), version(初始版本号 v1.0.0) | A | P0 | API管理 |
| 13 | POST | dubbo: FopPlatformService.publishApi() | apiId(要发布的API ID), version(发布版本号, 如v1.1.0), releaseNote(版本更新说明) | PublishResult: success(是否成功), publishTime(发布时间戳), apiStatus(变更后的API状态) | A | P1 | API管理 |
| 14 | POST | dubbo: FopPlatformService.subscribeApi() | appId(订阅方应用ID), apiId(要订阅的API ID), qpsLimit(申请的QPS上限, 默认100), dailyLimit(申请的日调用量上限, 默认10000) | SubscribeResult: subId(订阅记录ID), status(订阅生效状态: 0待审批/1已生效), qpsLimit(实际批准的QPS限制), dailyLimit(实际批准的日限制) | A | P1 | API管理 |
| 15 | POST | /dev/register | username(登录用户名, 4-30字符, 字母数字), password(密码, 8-20字符, 需含大小写字母+数字), email(电子邮箱, 用于接收通知), phone(手机号码, 11位), company(企业/组织名称, 可选) | RegisterResult: developerId(开发者ID), result_code(000000表示注册成功), message(提示信息: 注册成功请查收验证邮件) | A | P1 | 开发者管理 |
| # | 类型 | 方法签名 / URL | 入参 (中文说明) | 出参 (中文说明) | 评级 | 优先级 | 业务域 |
|---|---|---|---|---|---|---|---|
| 16 | POST | /api/apps/{id}/reset-key | id(路径参数, 应用ID) | ResetKeyResult: newAppKey(新生成的AppKey), newAppSecret(新的Secret, 仅显示一次!), resetTime(重置时间戳)
注意: 调用后旧密钥立即失效 |
B | P1 | 应用管理 |
| 17 | POST | /api/apps/{id}/freeze | id(应用ID), reason(冻结原因说明, 必填) | ResultDTO: code, message | B | P1 | 应用管理 |
| 18 | DELETE | /api/apps/{id} | id(要注销的应用ID) | ResultDTO: code, message(注销成功/失败原因) | B | P1 | 应用管理 |
| 19 | PUT | /api/apis/{id} | id(API ID), apiName, apiPath, httpMethod, apiCategory, description, requestParams, responseFormat(均为可选项) | ResultDTO: code, message | B | P1 | API管理 |
| 20 | GET | /api/apis/{id} | id(API ID) | ApiDetailVO: apiId, apiName, apiPath, httpMethod, category, status, description, versions(版本历史列表), subscriberCount(当前订阅数), callStats(最近30天调用量统计) | B | P1 | API管理 |
| 21 | GET | /api/apis | category(分类筛选), keyword(名称/路径搜索), status(状态筛选), pageNo, pageSize | PageResult<ApiInfoVO>: list, totalCount, pageNum, pageSize | B | P1 | API管理 |
| 22 | POST | /api/apis/{id}/publish | id(API ID), version(版本号, 如v2.0.0) | PublishResult: success, publishTime, apiStatus | B | P1 | API管理 |
| 23 | POST | /dev/certify | developerId(开发者ID), realName(真实姓名, 与身份证一致), idCard(身份证号码, 18位), idCardFront(身份证正面照URL), idCardBack(身份证背面照URL) | CertifyResult: result_code, auditStatus(0待审核/1通过/2驳回), rejectReason(驳回原因, 仅驳回时返回) | B | P1 | 开发者管理 |
| 24 | GET | /stats/calls/overview | dateRange(日期范围, 格式2026-01-01~2026-06-13), appId(可选, 筛选特定应用的统计) | CallOverview: totalCalls(总调用量), successRate(成功率百分比, 如99.8), avgResponseTime(平均响应耗时ms), errorCount(错误总数), p99Latency(P99延迟ms) | B | P1 | 监控统计 |
| 25 | GET | /stats/calls/trend | dateRange, granularity(粒度: hour/day/month), appId(可选) | TrendData: points(数据点数组, 每个点含timestamp/value/label三个字段) | B | P1 | 监控统计 |
| 26 | POST | dubbo: FopAuthService.logout() | token(要注销的JWT令牌) | LogoutResult: success(true/false), message | B | P1 | 认证授权 |
| 27 | POST | dubbo: FopPlatformService.auditApp() | applyId(申请单ID), auditOpinion(审核意见), auditResult(审核结果: pass/reject) | AuditResult: applyId, newStatus(变更后的应用状态), message | B | P1 | 应用管理 |
| 28 | POST | /api/apis/{id}/deprecate | id(API ID), reason(弃用原因说明) | DeprecateResult: deprecatedDate(弃用日期), migrateTo(推荐的替代API ID, 如果有的话) | B | P2 | API管理 |
| 29 | GET | /api/apis/{id}/docs | id(API ID) | ApiDocVO: docContent(Markdown格式的API文档内容), examples(调用示例数组, 每例含request/response), errorCodes(错误码列表) | B | P2 | API管理 |
| 30 | GET | /dev/profile | (使用Header中的Authorization: Bearer token进行身份识别) | DeveloperProfileVO: developerId, username, realName, email, phone, company, certStatus(认证状态), certTime(认证时间), appCount(已创建的应用数量) | B | P2 | 开发者管理 |
| 31 | PUT | /dev/profile | email(新邮箱), phone(新手机号), company(新企业名称)(均为可选项) | ResultDTO: code, message | B | P2 | 开发者管理 |
| 32 | GET | /audit/logs | startTime(开始时间), endTime(结束时间), operator(操作人, 可选), action(操作类型, 可选), pageNo, pageSize | PageResult<AuditLogVO>: list(审计日志, 每条含logId/operator/action/target/resource/detail/time/ip), totalCount | B | P2 | 日志审计 |
| 33 | GET | /stats/alerts | status(未读/已读), level(warning/critical), dateRange(可选) | List<AlertVO>: alertId, alertName(告警名称), level, triggerCondition(触发条件), currentValue(当前值), threshold(阈值), alertTime, status(是否已读/已处理) | B | P2 | 监控统计 |
| 34-47 | 其余 B 级接口(系统字典CRUD、配置参数管理、角色权限维护等)共 14 个，遵循相同的数据结构模式 | ||||||
| # | 类型 | 方法签名 / URL | 入参 (中文说明) | 出参 (中文说明) | 评级 | 优先级 | 业务域 |
|---|---|---|---|---|---|---|---|
| 48 | GET | /dev/apps | status(按应用状态筛选), pageNo, pageSize | PageResult<AppSummaryVO>: list(自己创建的应用简要列表, 含appId/appName/status/createTime), totalCount | C | P2 | 开发者管理 |
| 49 | GET | /stats/calls/top | dateRange, topN(TOP数量, 默认10), sortBy(排序维度: calls/errors/time) | TopList: rank(排名), name(应用或API名称), value(指标值), percentage(占比百分比) | C | P2 | 监控统计 |
| 50 | GET | /stats/apps/rank | dateRange, topN(默认20) | RankList: rank, appId, appName, totalCalls(累计调用量), activeDays(活跃天数), lastCallTime(最后调用时间) | C | P2 | 监控统计 |
| 51 | GET | /api/apis/{id}/subscribers | id(API ID), status(订阅状态筛选, 可选), pageNo, pageSize | PageResult<SubscriberVO>: list(订阅者列表, 含appName/subscriberName/qpsLimit/dailyLimit/subscribeTime/status) | C | P2 | API管理 |
| 52 | GET | /sys/dict/types | (无参数, 或name按字典类型名称模糊搜) | List<DictTypeVO>: dictTypeId, dictTypeName, dictTypeCode, description, itemCount(字典项数量) | C | P3 | 系统管理 |
| 53 | GET | /sys/dict/items | dictTypeId(字典类型ID, 必填) | List<DictItemVO>: itemId, itemLabel(显示名称), itemValue(存储值), sortOrder(排序号), status(启用/禁用) | C | P3 | 系统管理 |
| 54 | POST | /sys/dict/item | dictTypeId, itemLabel, itemValue, sortOrder, status | ResultDTO: code, message, data(新增itemId) | C | P3 | 系统管理 |
| 55 | GET | /audit/log/{id} | id(审计日志ID) | AuditLogDetailVO: logId, operator, operatorIp, action, target, resource, detail(操作详情JSON), time, relatedLogs(关联操作日志列表) | C | P2 | 日志审计 |
| 56 | GET | /audit/export | startTime, endTime, format(导出格式: csv/excel), operator(可选) | FileDownload(文件流): 审计日志导出文件 | C | P2 | 日志审计 |
| 57-92 | 其余 C 级接口(通知管理/文件上传下载/API测试控制台/开发者社区帖子评论等)共 36 个 | ||||||
| # | 类型 | 方法签名 / URL | 入参 (中文说明) | 出参 (中文说明) | 评级 | 优先级 | 业务域 |
|---|---|---|---|---|---|---|---|
| 93 | GET | /health | (无参数) | HealthVO: status(UP/DOWN), components(Map: 各组件健康状态) | D | P3 | 系统管理 |
| 94 | GET | /info | (无参数) | InfoVO: appName, version, buildTime, gitCommit, javaVersion | D | P3 | 系统管理 |
| 95 | GET | /sys/config/{key} | key(配置键名) | ConfigVO: key, value(配置值, 敏感值脱敏), description, updateTime | D | P3 | 系统管理 |
| 96 | POST | /dev/password/reset | email(注册邮箱) 或 phone(手机号, 二选一) | ResultDTO: code(000000表示重置邮件/短信已发送), message | D | P3 | 开发者管理 |
| 97 | GET | /audit/log/{id}/diff | id(审计日志ID, 要求是修改类操作) | DiffVO: beforeValue(修改前快照), afterValue(修改后快照), changedFields(变化的字段列表) | D | P3 | 日志审计 |
| 98-122 | 其余 D 级接口(心跳检测/版本信息/简单查询/静态资源配置等)共 25+ 个 | ||||||
| # | Mapper 接口 | 方法签名 | SQL类型 | 功能描述 | 评级 | |
|---|---|---|---|---|---|---|
| 1 | AppInfoDao | insert(AppInfoPO) | INSERT | 新增应用记录 | B | |
| 2 | AppInfoDao | updateById(AppInfoPO) | UPDATE | 按主键更新应用 | B | |
| 3 | AppInfoDao | selectById(Long id) | SELECT | 按ID查询应用 | B | |
| 4 | AppInfoDao | selectPage(@Param("qw") QueryWrapper) | SELECT | 分页条件查询应用 | B | |
| 5 | ApiInfoDao | insert(ApiInfoPO) | INSERT | 新增API记录 | B | |
| 6 | ApiInfoDao | selectByPathAndMethod(@Param("path") String path, @Param("method") String method) | SELECT | 按路径+方法查API(唯一性校验) | B | |
| 7 | DeveloperDao | insert(DeveloperPO) | INSERT | 新增开发者 | C | |
| 8 | DeveloperDao | selectByUsername(String username) | SELECT | 按用户名查开发者(登录用) | C | |
| 9 | ApplyRecordDao | insert(ApplyRecordPO) | INSERT | 新增申请记录 | C | |
| 10 | ApplyRecordDao | updateStatusById(@Param("id") Long id, @Param("status") int status) | UPDATE | 更新申请状态 | C | |
| 11 | SubscriptionDao | insert(ApiSubscriptionPO) | INSERT | 新增API订阅关系 | C | |
| 12 | SubscriptionDao | selectByAppId(Long appId) | SELECT | 查询某应用的所有订阅 | C | |
| 13-18 | 其他 Mapper 方法(删除操作/统计查询/批量操作等)共 6 个 | D | ||||
dubbo: 前缀的接口。
| Provider | 方法组 | 方法数 | 主要方法 | 评级 |
|---|---|---|---|---|
| FopAuthProvider | 认证服务 | 6 | authenticate(), refreshToken(), logout(), checkToken(), getPermissions(), validateSign() | A |
| FopPlatformProvider | 平台核心服务 | 18 | createApp(), updateApp(), getApp(), submitForAudit(), auditApp(), freezeApp(), createApi(), publishApi(), deprecateApi(), subscribeApi(), querySubscriptions(), getDevProfile(), certifyDeveloper(), ... | A |
| FopStatProvider | 统计服务 | 7 | getCallOverview(), getCallTrend(), getTopApis(), getAppRank(), getAlertList(), exportStats() | B |
| FopAuditProvider | 审计服务 | 4 | queryLogs(), getLogDetail(), exportLogs(), getDiffSnapshot() | B |