Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add devportal example of developer side #7

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# 展示端示例

## 注册开发者

### 暂不支持

## 新增应用

### 使用场景

用于创建一个新的应用。

### 使用限制

应用的名称在初次创建后后续不可再修改。

### 操作步骤

**步骤1**:点击左侧导航进入「我的应用」页面。

**步骤2**:点击右上角「新增应用」按钮。

**步骤2**:在表单中填写应用信息并提交。

### 验证方式

创建应用成功后,应用列表第一条数据即为最新添加的应用,点击应用名称可以进入应用详情页,查看更加详细的应用信息:

## 查找API

### 暂不支持

## 订阅API

### 使用场景

开发者可以以 `应用` 为主体申请订阅 API。订阅成功后应用方可调用此 API。如果 API 开启了认证,则应用会获得对应的访问凭证。

### 使用限制

暂不支持已经订阅成功的应用更换访问凭证。

### 操作步骤

**步骤1**:点击左侧导航进入「API 市场」页面。

**步骤2**:选择一个 API,点击右侧「订阅」按钮。

**步骤3**:选择要订阅 API 的应用,点击确定提交订阅申请。

### 验证方式

在提交订阅申请成功后,可以应用详情中的 「API 订阅」 查看当前应用订阅的所有 API 信息。

## 调用API

### 使用场景

### 使用限制

### 操作步骤

### 验证方式

## 取消订阅API

### 使用场景

在 API 订阅成功后,可以在我的 API 或我的应用的取消 API 的订阅。

### 使用限制

暂无

### 操作步骤

**步骤1**:点击左侧导航进入「我的 API」页面。

**步骤2**:选择一个审批状态为成功 API,点击右侧「取消订阅」按钮。

**步骤3**:在弹窗中确认取消订阅的 API 信息,点击「确认」按钮。

### 验证方式

取消 API 订阅后,API 会在 API 列表中移除,且在订阅 API 的应用中的 API 列表中也会移除。

## 删除应用

### 暂不支持

## 编辑应用描述

### 使用场景

### 使用限制

### 操作步骤

**步骤1**:点击左侧导航进入「我的应用」页面。

**步骤2**:点击应用列表操作栏编辑按钮。

**步骤3**:编辑应用相关信息并提交。

### 验证方式

编辑成功后,可以在列表中查看新的应用描述及更新时间。

## 撤回API订阅申请

### 使用场景

在提交 API 订阅申请后,如果 API 订阅申请还未审批,可以在我的 API 或我的应用的取消 API 的订阅。

### 使用限制

暂无

### 操作步骤

**步骤1**:点击左侧导航进入「我的 API」页面。

**步骤2**:选择一个审批状态为审核中 API,点击右侧「撤回」按钮。

**步骤3**:在弹窗中确认撤回订阅的 API 信息,点击「确认」按钮。

### 验证方式

撤回 API 订阅申请后,API 会在 API 列表中移除,且在订阅 API 的应用中的 API 列表中也会移除。

## 新增开发者

### 使用场景

将一个新的开发者添加到开发者门户,为其创建登陆开发者门户系统的账号,并且根据角色赋予使用开发者门户系统的权限。

### 使用限制

1. 开发者的邮箱,会作为登陆开发者门户系统账户的默认账号和密码,因此在系统层面具有唯一性。
2. 需要提前创建开发者所在的组织信息;
3. 不支持变更开发者所在组织,只能删除开发者后重新创建。

### 操作步骤

**步骤1**:点击左侧导航进入「开发者」页面。

**步骤2**:点击右上角「新增开发者」按钮。

**步骤2**:在表单中填写开发者信息并提交。

### 验证方式

创建应用成功后,开发者列表第一条数据即为最新添加的开发者。点击开发者名称可以进入详情页,查看更加详细的开发者信息。

## 删除开发者

### 暂不支持

## 修改登录密码

### 暂不支持