Skip to content

Commit

Permalink
docs: add document for outputs (#44)
Browse files Browse the repository at this point in the history
* doc: update outputs doc

* doc: fix type misrender

* doc: modify link from relative to absolute

* Update README.md

move output.md introduce part
  • Loading branch information
wwwzbwcom authored Jan 18, 2021
1 parent aa64092 commit 9814c9a
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ serverless deploy

> **说明**:如果鉴权失败,请参考 [权限配置](https://cloud.tencent.com/document/product/1154/43006) 进行授权。
部署完成后,控制台会打印相关的输出信息,您可以通过 `${output:${stage}:${app}:apigw.url}` 的形式在其他 `serverless` 组件中引用该组件的 API 网关访问链接(或通过类似的形式引用该组建其他输出结果),具体的,可以查看完成的输出文档:

- [点击此处查看输出文档](https://github.com/serverless-components/tencent-koa/tree/master/docs/output.md)

### 4. 配置

koa 组件支持 0 配置部署,也就是可以直接通过配置文件中的默认值进行部署。但你依然可以修改更多可选配置来进一步开发该 koa 项目。
Expand Down
54 changes: 54 additions & 0 deletions docs/output.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 部署 output 参数介绍

> 组件输出可以在别的组件中通过 `${output:${stage}:${app}:<name>.<variable_name>}` 获取
>
> 例如,如果该组件名称是 `test_name`, ·且只部署于一个地域,则可以通过 `${output:${stage}:${app}:test_name.apigw.url}` 在别的组件中获取该组件的 API 网关的 `url`
| 名称 | 类型 | 描述 |
| :---------- | :-------------: | :----------------------------------------------------- | ---------------- |
| templateUrl | string | 未提供代码时的模板代码 url |
| region | string | 地域信息(只有一个地域时才提供) |
| scf | [`FunctionOutput | Record<string,FunctionOutput>`](#云函数输出-`FunctionOutput`) | 云函数输出信息 |
| apigw | [`ApigwOutput | Record<string:ApigwOutput>`](#API-网关输出-`ApigwOutput`) | API 网关输出信息 |

## 云函数输出 `FunctionOutput`

| 名称 | 类型 | 描述 |
| :------------------- | :------------: | :--------------------- |
| functionName | string | 云函数名称 |
| runtime | string | 云运行环境 |
| namespace | string | 云函数名称空间 |
| lastVersion | string | 云函数版本 |
| traffic | `number (0~1)` | 将多少流量导向该云函数 |
| configTrafficVersion | string | |

## API 网关输出 `ApigwOutput`

| 名称 | 类型 | 描述 |
| :------------ | :------------------------------------------------------------------: | :------------------------- | ------- | -------- |
| serviceId | string | API 网关 ID |
| subDomain | string | API 网关子域名 |
| enviroment | `"release" | "prepub" | "test"` | API 网关 |
| url | string | API 网关对外的完整 URL |
| traffic | number (0~1) | 将多少流量导向该云函数 |
| customDomains | [CustomDomain[]](#API-网关自定义域名输出-`ApigwOutput.CustomDomain`) | API 网关自定义域名输出列表 |

## API 网关自定义域名输出 `ApigwOutput.CustomDomain`

| 名称 | 类型 | 描述 |
| :--------------- | :----------------------------------------------------------------: | :------------------------- | ---------- |
| domain | string | 自定义域名 |
| certificateId | string | 域名证书 ID |
| isDefaultMapping | boolean | 该自定义域名是否为默认域名 |
| pathMappingSet | [PathMapping[]](#-API-网关域名映射规则-`CustomDomain.PathMapping`) | 该域名的路径映射规则列表 |
| protocols | `"http" | "https"` | 启用的协议 |



## API 网关域名映射规则 `CustomDomain.PathMapping`

| 名称 | 类型 | 描述 |
| :--------- | :----: | :--------------- |
| path | string | 路径 |
| enviroment | string | 路径映射到的环境 |

0 comments on commit 9814c9a

Please sign in to comment.