Skip to content

feat: update toolkit and doc, support apigw app and instance #72

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jul 30, 2021
Merged

feat: update toolkit and doc, support apigw app and instance #72

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d7b7f7
feat: update toolkit and doc, support apigw app and instance
wwwzbwcom Jul 19, 2021
c3b3470
docs: add is-neccesary in configure.md
wwwzbwcom Jul 28, 2021
31934ea
fix: fix doc authType, fix scf_bootstrap
wwwzbwcom Jul 29, 2021
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
41 changes: 28 additions & 13 deletions docs/configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,15 +375,16 @@ mps - MPS 触发器

#### API 网关触发器

| 参数名称 | 必选 | 类型 | 默认值 | 描述 |
| ----------- | ---- | :------: | :---------- | :----------------------------------------------------------------------------- |
| environment | 否 | string | `release` | 发布的环境，填写 `release`、`test` 或 `prepub`，不填写默认为`release` |
| serviceId | 否 | string | | 网关 Service ID（不传入则新建一个 Service） |
| protocols | 否 | string[] | `['http']` | 前端请求的类型，如 http，https，http 与 https |
| netTypes | 否 | string[] | `['OUTER']` | 网络类型，如 `['OUTER']`, `['INNER']` 与`['OUTER', 'INNER']` |
| serviceName | 否 | string | | 网关 API 名称。如果不传递则默认新建一个名称与触发器名称相同的 Apigw API 名称。 |
| description | 否 | string | | 网关 API 描述 |
| endpoints | 是 | object[] | | 参考 [endpoint](#endpoints-参数) 参数。 |
| 参数名称 | 必选 | 类型 | 默认值 | 描述 |
| ----------- | ---- | :------: | :---------- | :--------------------------------------------------------------------------------------------------------- |
| environment | 否 | string | `release` | 发布的环境，填写 `release`、`test` 或 `prepub`，不填写默认为`release` |
| serviceId | 否 | string | | 网关 Service ID（不传入则新建一个 Service） |
| instanceId | 否 | string | | 网关实例 ID，填写则使用独享型实例创建 API 网关，否则创建共享型实例（该项只能在创建时指定，创建后无法修改） |
| protocols | 否 | string[] | `['http']` | 前端请求的类型，如 http，https，http 与 https |
| netTypes | 否 | string[] | `['OUTER']` | 网络类型，如 `['OUTER']`, `['INNER']` 与`['OUTER', 'INNER']` |
| serviceName | 否 | string | | 网关 API 名称。如果不传递则默认新建一个名称与触发器名称相同的 Apigw API 名称。 |
| description | 否 | string | | 网关 API 描述 |
| endpoints | 是 | object[] | | 参考 [endpoint](#endpoints-参数) 参数。 |

> 注意：如果配置多个 API 网关触发器，需要配置不同的 `serviceName`

Expand All @@ -405,6 +406,8 @@ mps - MPS 触发器
| function | 否 | [Function](#Function) | | SCF 配置 |
| usagePlan | 否 | [UsagePlan](#UsagePlan) | | 使用计划 |
| auth | 否 | [Auth](#Auth) | | API 密钥配置 |
| authType | 否 | string | `NONE` | `NONE` 或 `APP` |
| app | 否 | [App](#App) | | API 绑定 APP 配置 |
| isBase64Encoded | 否 | boolean | `false` | 是否开启 Base64 编码，只有后端为 scf 时才会生效 |
| isBase64Trigger | 否 | boolean | `false` | 是否开启 Base64 编码的 header 触发，只有后端为 scf 时才会生效 |
| base64EncodedTriggerRules | 否 | [Base64Rule](#Base64Rule)[] | [] | Header 触发 Base64 编码规则，总规则数不能超过 10，只有 `isBase64Trigger` 设置为 `true` 才有效 |
Expand Down Expand Up @@ -450,10 +453,22 @@ API 密钥配置

参考: https://cloud.tencent.com/document/product/628/14916

| 参数名称 | 类型 | 描述 |
| ---------- | :----- | :------- |
| secretName | string | 密钥名称 |
| secretIds | string | 密钥 ID |
| 参数名称 | 必选 | 类型 | 描述 |
| ---------- | :--: | :----- | :------- |
| secretName | 否 | string | 密钥名称 |
| secretIds | 否 | string | 密钥 ID |

###### APP

API 绑定 APP 配置

参考：https://cloud.tencent.com/document/product/628/55087

| 参数名称 | 必选 | 类型 | 描述 |
| ----------- | :--: | :----- | :------------------ |
| name | 否 | string | 用户自定义 APP 名称 |
| id | 否 | string | APP ID |
| description | 否 | string | 用户自定义 APP 描述 |

###### Base64Rule

Expand Down