wecom openapi

简体中文

説明

このプロジェクトは、さまざまなプログラミング言語でクライアント コードを生成できるように、WeCom ドキュメントを OpenAPI 仕様に翻訳することを目的としています。現在、OpenAPI 仕様のバージョン 3.x を使用しています。

インストール

$ npm install

アプリの実行

アプリの実行中に、OpenAPI 仕様ファイルopenapi.yamlが生成されます。 http://localhost:3000/openapiを開いて Swagger UI を表示できます。

$ npm run start

クライアントコードの生成

swagger-codegen は、OpenAPI 仕様からコードを生成するための非常に人気のあるツールです。ただし、Golang を使用している場合は、go-swagge をお勧めします。

例

go-swagge は OpenAPI 仕様 2.0 に基づいているため、バージョンをダウングレードする必要があります。

$ npm install -g api-spec-converter
$ api-spec-converter --from=openapi_3 --to=swagger_2 --syntax=yaml --order=alpha ./openapi.yaml > swagger.yaml

次に、 swagger.yamlファイルから Golang コードを生成します。

 $ brew tap go-swagger/go-swagger

$ brew install go-swagger

$ mkdir wecom-api && cd wecom-api

# NOTE: you need run go mod init to create a go.mod file
$ go mod init wecom-api

$ swagger generate client -f swagger.yaml -t wecom-api

開発者

このプロジェクトは、NestJS の Swagger 統合に基づいています。詳細はOpenAPI(NestJS)を参照してください。

コントローラーファイルの API 定義

 nest g --no-spec controller department

DTO と応答構造の作成

通常、DTO と応答は別のクラスで宣言します。

 nest g --no-spec class department/Department

API プロパティ

  @ApiProperty({
    required: false,
    type: 'string',
    isArray: true,
    maxItems: 100,
    example: '["abel"]',
    description: 'user id list, max length is 100',
  })
  userid_list: string[];

• required 、 type必須です。
• description 、 exampleお勧めします。

  @ApiOperation({
    operationId: 'getGroupChat',
    summary: 'Get user group detail',
    description: 'Get user group detail',
    externalDocs: {
      url: 'https://developer.work.weixin.qq.com/document/path/92122',
    },
  })

• operationId必須、一意、生成コード内の関数名です。
• summary必須
• externalDocs WeCom 公式ドキュメントへのリンク。

Swagger UI 試してみる

承認する

まず、API 呼び出しを承認するためにaccess_token取得する必要があります。

プロキシ

ブラウザに CORS の問題があるため、wx-work に直接アクセスできません。そこで私たちはあなたのために代理人を作りました。アクセスするには、 http://localhost:3000/cgi-binを使用します。