应用管理

应用是权限管理的容器,每个应用都有自己的 API 和权限。应用管理允许开发者在 Passport 平台上注册自己的应用,并定义应用的 API 接口清单和权限体系。

应用概述

应用是指需要接入 Passport 认证鉴权的业务系统或服务。每个应用在 Passport 中都有独立的:

  • 应用 ID(App Key):应用的唯一标识
  • API 列表:应用暴露的所有接口
  • 权限列表:应用定义的权限
  • 应用账号:用于服务间调用的账号

应用信息

每个应用包含以下信息:

字段说明
应用 ID(App Key)应用的唯一标识,创建时自动生成
应用名称应用名称
描述应用描述信息
创建时间应用创建时间

应用列表

在应用列表中可以查看所有已注册的应用:

字段说明
应用 ID点击可进入详情页
应用名称应用名称
描述应用描述信息
创建时间应用创建时间

创建应用

  1. 进入「应用」页面
  2. 点击「创建应用」
  3. 填写以下信息:
    • 应用名称(必填)
    • 描述(选填)
  4. 点击「确认」创建

创建应用成功后,系统会自动生成应用 ID(App Key),用于唯一标识该应用。

应用详情

在应用列表中点击应用 ID,可以进入应用详情页面。应用详情包含以下标签页:

标签页内容说明
基本信息卡应用基本信息显示应用 ID、名称、描述等
权限该应用下创建的所有权限只读,列出权限名称和接口数量
接口该应用下定义的所有 API可以添加、编辑、删除接口

管理接口

接口是权限控制的基本单位,每个接口代表一个具体的 API 端点。

创建接口

  1. 进入应用详情
  2. 切换到「接口」标签
  3. 点击「创建接口」
  4. 填写以下信息:
    • 接口名称(必填)
    • 请求路径(必填)
    • 请求方法(必填,支持 GET/POST/PUT/DELETE)
    • 描述(选填)
  5. 点击「确认」创建

编辑接口

  1. 进入应用详情
  2. 切换到「接口」标签
  3. 找到要编辑的接口
  4. 点击编辑按钮
  5. 修改接口信息
  6. 点击「确认」保存

删除接口

  1. 进入应用详情
  2. 切换到「接口」标签
  3. 找到要删除的接口
  4. 点击删除按钮
  5. 确认删除

注意:删除接口后,该接口将从所有关联的权限中移除。

导出接口列表

应用管理支持导出接口列表,方便在开发过程中使用。

  1. 进入应用详情
  2. 切换到「接口」标签
  3. 点击「导出」按钮
  4. 选择导出格式
  5. 保存导出文件

接口信息

每个接口包含以下信息:

字段说明
接口名称接口的名称
请求路径接口的请求路径,支持通配符(如 /api/user/*
请求方法HTTP 方法(GET/POST/PUT/DELETE)
描述接口描述信息
更新时间接口最后更新时间

接口路径匹配规则

Passport SDK 支持灵活的接口路径匹配规则:

路径模式说明匹配示例
/api/user精确匹配/api/user
/api/user/*前缀匹配/api/user/1, /api/user/info
/api/user/{id}路径变量匹配/api/user/123, /api/user/abc

创建应用账号

应用需要账号来进行服务间认证。

创建应用账号

  1. 进入「账号」页面
  2. 切换到「应用账号」标签
  3. 点击「创建账号」
  4. 填写以下信息:
    • 用户 ID(必填)
    • 名称(必填)
    • 所属应用(必填,选择该应用)
    • 描述(选填)
  5. 点击「确认」创建

管理凭证

创建应用账号后,需要创建 Access Key 凭证:

  1. 进入应用账号详情
  2. 切换到「凭证」标签
  3. 点击「创建凭证」
  4. 保存生成的 Access Key ID 和 Secret Access Key

应用集成流程

完成应用注册后,按照以下步骤集成 Passport:

  1. 创建应用:在管理后台创建应用,获取应用 ID
  2. 定义接口:将应用的 API 接口清单注册到应用中
  3. 创建权限:定义应用的权限级别(管理员、操作者、只读等)
  4. 关联接口:将接口关联到对应的权限
  5. 创建应用账号:创建应用服务账号,获取 Access Key
  6. 引入 SDK:在应用代码中引入 Passport SDK
  7. 配置 SDK:配置应用 ID、Access Key、公钥等信息
  8. 测试验证:测试认证鉴权功能是否正常

详细的 SDK 集成步骤请参考 Passport SDK 集成

注意事项

  • 应用 ID(App Key)是应用的重要标识,请妥善保存
  • 接口路径的匹配规则与 Spring Boot 的路径匹配规则一致
  • 建议按照功能模块组织接口和权限
  • 定期审查接口和权限配置,确保安全性