# @serverless/tencent-apigateway

> Tencent Cloud API Gateway

Latest version **2.1.6** (published 2020-04-02) · Apache license · 0 weekly downloads

## Install

```sh
npm install @serverless/tencent-apigateway
pnpm add @serverless/tencent-apigateway
yarn add @serverless/tencent-apigateway
bun add @serverless/tencent-apigateway
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.6 |
| Published | 2020-04-02 |
| First published | 2019-10-24 |
| Weekly downloads | 0 |
| License | Apache |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 79 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Tencent Cloud, Inc. |
| Maintainers | ac360, aj.stuyvenberg, anycodes, eahefnawy, hkbarton, yugasun |

## Links

- npm: https://www.npmjs.com/package/@serverless/tencent-apigateway
- npm.io page: https://npm.io/package/@serverless/tencent-apigateway

## Dependencies (5)

- [joi](https://npm.io/package/joi.md) ^14.3.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [qcloudapi-sdk](https://npm.io/package/qcloudapi-sdk.md) ^0.2.1
- [@serverless/core](https://npm.io/package/@serverless/core.md) ^1.0.0
- [serverless-tencent-auth-tool](https://npm.io/package/serverless-tencent-auth-tool.md) ^1.0.14

## Recent versions

- 2.1.6 (latest) — 2020-04-02
- 2.1.5 — 2020-03-13
- 2.1.4 — 2020-03-12
- 2.1.3 — 2020-03-10
- 2.1.2 — 2020-02-18
- 2.1.1 — 2020-02-18
- 2.1.0 — 2020-02-17
- 2.0.8 — 2020-02-08
- 2.0.7 — 2020-02-05
- 2.0.6 — 2020-02-05
- 2.0.5 — 2020-02-05
- 2.0.4 — 2020-02-04
- 2.0.3 — 2020-02-04
- 2.0.2 — 2020-01-28
- 2.0.1 — 2020-01-14
- … 18 more at https://npm.io/package/@serverless/tencent-apigateway/versions

## README

# 腾讯云API网关组件

 

* [请点击这里查看英文版部署文档](./README_EN.md)

## 简介
该组件是serverless-tencent组件库中的基础组件之一。通过API网关组件，可以快速，方便的创建，配置和管理腾讯云的API网关产品。

## 快速开始
 

通过API网关组件，对一个API服务/接口进行完整的创建，配置，部署和删除等操作。支持命令如下：

1. [安装](#1-安装)
2. [配置](#2-配置)
3. [部署](#3-部署)
4. [移除](#4-移除)

 

### 1. 安装

通过npm安装serverless

```console
$ npm install -g serverless
```

### 2. 配置

本地创建 `serverless.yml` 文件，在其中进行如下配置

```console
$ touch serverless.yml
```

```yml
# serverless.yml

restApi:
  component: "@serverless/tencent-apigateway"
  inputs:
    region: ap-shanghai
    protocols:
      - http
      - https
    serviceName: serverless
    environment: release
    endpoints:
      - path: /users
        method: POST
        function:
          functionName: myFunction

```

* [点击此处查看配置文档](https://github.com/serverless-tencent/tencent-apigateway/blob/master/docs/configure.md)

### 3. 部署

如您的账号未[登陆](https://cloud.tencent.com/login)或[注册](https://cloud.tencent.com/register)腾讯云，您可以直接通过`微信`扫描命令行中的二维码进行授权登陆和注册。

通过`sls`命令进行部署，并可以添加`--debug`参数查看部署过程中的信息

```console
$ sls --debug

  DEBUG ─ Resolving the template's static variables.
  DEBUG ─ Collecting components from the template.
  DEBUG ─ Downloading any NPM components found in the template.
  DEBUG ─ Analyzing the template's components dependencies.
  DEBUG ─ Creating the template's components graph.
  DEBUG ─ Syncing template state.
  DEBUG ─ Executing the template's components graph.
  DEBUG ─ Starting API-Gateway deployment with name restApi in the ap-shanghai region
  DEBUG ─ Service with ID service-g1ihx7c7 created.
  DEBUG ─ API with id api-4dv8r7wg created.
  DEBUG ─ Deploying service with id service-g1ihx7c7.
  DEBUG ─ Deployment successful for the api named restApi in the ap-shanghai region.

  restApi:
    protocols:
      - http
      - https
    subDomain:   service-g1ihx7c7-1300415943.ap-shanghai.apigateway.myqcloud.com
    environment: release
    region:      ap-shanghai
    serviceId:   service-g1ihx7c7
    apis:
      -
        path:   /users
        method: POST
        apiId:  api-4dv8r7wg

  24s › restApi › done

```

### 4. 移除

通过以下命令移除部署的API网关
```console
$ sls remove --debug

  DEBUG ─ Flushing template state and removing all components.
  DEBUG ─ Removing any previously deployed API. api-4dv8r7wg
  DEBUG ─ Removing any previously deployed service. service-g1ihx7c7

  13s › restApi › done

```

### 账号配置（可选）

当前默认支持CLI扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 `.env` 文件

```console
$ touch .env # 腾讯云的配置信息
```

在 `.env` 文件中配置腾讯云的SecretId和SecretKey信息并保存

如果没有腾讯云账号，可以在此[注册新账号](https://cloud.tencent.com/register)。

如果已有腾讯云账号，可以在[API密钥管理](https://console.cloud.tencent.com/cam/capi)中获取 `SecretId` 和`SecretKey`.

```
# .env
TENCENT_SECRET_ID=123
TENCENT_SECRET_KEY=123
```

### 还支持哪些组件？

可以在 [Serverless Components](https://github.com/serverless/components) repo 中查询更多组件的信息。

---
_Source: https://npm.io/package/@serverless/tencent-apigateway · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._