├── .editorconfig ├── .eslintrc.js ├── .github ├── ISSUE_TEMPLATE │ ├── bug.md │ ├── documentation.md │ └── feature.md ├── PULL_REQUEST_TEMPLATE.md └── workflows │ └── npm.yml ├── .gitignore ├── .vscode └── settings.json ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── RESOURCES.md ├── bin └── wechaty-openapi-server.ts ├── docs └── images │ ├── grpc-gateway-architecture.svg │ ├── grpc-rest-logo.png │ ├── openapi.png │ ├── restful-grpc.jpg │ ├── swagger.jpg │ ├── wechaty-openapi-logo.svg │ ├── wechaty-openapi-swagger-ui.png │ └── wechaty-openapi.png ├── examples └── proxy.ts ├── package.json ├── scripts ├── generate-version.sh ├── npm-pack-testing.sh └── package-publish-config-tag.sh ├── src ├── config.ts ├── mod.ts ├── openapi.spec.ts ├── openapi.ts ├── typings.d.ts ├── version.spec.ts └── version.ts ├── tests ├── fixtures │ └── smoke-testing.ts └── integration.spec.ts └── tsconfig.json /.editorconfig: -------------------------------------------------------------------------------- 1 | # Editor configuration, see http://editorconfig.org 2 | root = true 3 | 4 | [*] 5 | charset = utf-8 6 | indent_style = space 7 | indent_size = 2 8 | end_of_line = lf 9 | insert_final_newline = true 10 | trim_trailing_whitespace = true 11 | 12 | [*.md] 13 | max_line_length = 0 14 | trim_trailing_whitespace = false 15 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | 2 | const rules = { 3 | } 4 | 5 | module.exports = { 6 | extends: '@chatie', 7 | rules, 8 | } 9 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 🐛 Bug Report 3 | about: Submit a bug report to help us improve 4 | --- 5 | 6 | ## 🐛 Bug Report 7 | 8 | (A clear and concise description of what the bug is.) 9 | 10 | ## To Reproduce 11 | 12 | (Write your steps here:) 13 | 14 | 1. Step 1... 15 | 1. Step 2... 16 | 1. Step 3... 17 | 18 | ## Expected behavior 19 | 20 | (Write what you thought would happen.) 21 | 22 | ## Actual Behavior 23 | 24 | (Write what happened. Add screenshots, if applicable.) 25 | 26 | ## Your Environment 27 | 28 | (Environment name, version and operating system.) -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/documentation.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 📚 Documentation 3 | about: Report an issue related to documentation 4 | --- 5 | 6 | ## 📚 Documentation 7 | 8 | (A clear and concise description of what the issue is.) -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: 🚀 Feature 3 | about: Submit a proposal/request for a new feature 4 | --- 5 | 6 | ## 🚀 Feature 7 | 8 | (A clear and concise description of what the feature is.) -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | 11 | 12 | #### Checklist 13 | 14 | - [ ] Commit Messages follow the [Conventional Commits](https://conventionalcommits.org/) pattern 15 | - A feature commit message is prefixed "feat:" 16 | - A bugfix commit message is prefixed "fix:" 17 | - [ ] Tests for the changes have been added 18 | - [ ] CI has been passed. (GitHub actions all turns green) 19 | - [ ] CLA has been signed 20 | 21 | #### References to other Issues or PRs 22 | 23 | 28 | 29 | #### Have you read the [Contributing Guidelines](https://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md)? 30 | 31 | #### Brief description of what is fixed or changed 32 | 33 | #### Other comments 34 | 35 | 45 | -------------------------------------------------------------------------------- /.github/workflows/npm.yml: -------------------------------------------------------------------------------- 1 | name: NPM 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | build: 7 | name: Build 8 | strategy: 9 | matrix: 10 | os: [ubuntu-latest] 11 | node: [14] 12 | 13 | runs-on: ${{ matrix.os }} 14 | steps: 15 | - uses: actions/checkout@v2 16 | - name: Use Node.js ${{ matrix.node-version }} 17 | uses: actions/setup-node@v2 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - uses: actions/cache@v2 21 | with: 22 | path: ~/.npm 23 | key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }} 24 | restore-keys: | 25 | ${{ runner.os }}-wechaty- 26 | 27 | - name: Install Dependencies 28 | run: npm install 29 | 30 | - name: Test 31 | run: npm test 32 | 33 | pack: 34 | name: Pack 35 | needs: build 36 | runs-on: ubuntu-latest 37 | steps: 38 | - uses: actions/checkout@v2 39 | - uses: actions/setup-node@v2 40 | with: 41 | node-version: 14 42 | - uses: actions/cache@v2 43 | with: 44 | path: ~/.npm 45 | key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }} 46 | restore-keys: | 47 | ${{ runner.os }}-wechaty- 48 | 49 | - name: Install Dependencies 50 | run: npm install 51 | 52 | - name: Generate Version 53 | run: ./scripts/generate-version.sh 54 | 55 | - name: Pack Testing 56 | run: ./scripts/npm-pack-testing.sh 57 | env: 58 | WECHATY_PUPPET_SERVICE_TOKEN: ${{ secrets.WECHATY_PUPPET_SERVICE_TOKEN }} 59 | 60 | publish: 61 | if: github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/v')) 62 | name: Publish 63 | needs: [build, pack] 64 | runs-on: ubuntu-latest 65 | steps: 66 | - uses: actions/checkout@v2 67 | - uses: actions/setup-node@v2 68 | with: 69 | node-version: 14 70 | registry-url: https://registry.npmjs.org/ 71 | 72 | - uses: actions/cache@v2 73 | with: 74 | path: ~/.npm 75 | key: ${{ runner.os }}-wechaty-${{ hashFiles('**/package.json') }} 76 | restore-keys: | 77 | ${{ runner.os }}-wechaty- 78 | - name: Install Dependencies 79 | run: npm install 80 | 81 | - name: Generate Version 82 | run: ./scripts/generate-version.sh 83 | 84 | - name: Set Publish Config 85 | run: ./scripts/package-publish-config-tag.sh 86 | 87 | - name: Build Dist 88 | run: npm run dist 89 | 90 | - name: Check Branch 91 | id: check-branch 92 | run: | 93 | if [[ ${{ github.ref }} =~ ^refs/heads/(master|v[0-9]+\.[0-9]+.*)$ ]]; then 94 | echo ::set-output name=match::true 95 | fi # See: https://stackoverflow.com/a/58869470/1123955 96 | - name: Is A Publish Branch 97 | if: steps.check-branch.outputs.match == 'true' 98 | run: | 99 | NAME=$(npx pkg-jq -r .name) 100 | VERSION=$(npx pkg-jq -r .version) 101 | if npx version-exists "$NAME" "$VERSION" 102 | then echo "$NAME@$VERSION exists on NPM, skipped." 103 | else npm publish 104 | fi 105 | env: 106 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 107 | - name: Is Not A Publish Branch 108 | if: steps.check-branch.outputs.match != 'true' 109 | run: echo 'Not A Publish Branch' 110 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | 106 | generated/ 107 | t/ 108 | t.* 109 | 110 | package-lock.json 111 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "typescript.tsdk": "./node_modules/typescript/lib", 3 | 4 | "editor.fontFamily": "'Fira Code iScript', Consolas, 'Courier New', monospace", 5 | "editor.fontLigatures": true, 6 | 7 | "editor.tokenColorCustomizations": { 8 | "textMateRules": [ 9 | { 10 | "scope": [ 11 | //following will be in italics (=Pacifico) 12 | "comment", 13 | // "entity.name.type.class", //class names 14 | "keyword", //import, export, return… 15 | "support.class.builtin.js", //String, Number, Boolean…, this, super 16 | "storage.modifier", //static keyword 17 | "storage.type.class.js", //class keyword 18 | "storage.type.function.js", // function keyword 19 | "storage.type.js", // Variable declarations 20 | "keyword.control.import.js", // Imports 21 | "keyword.control.from.js", // From-Keyword 22 | "entity.name.type.js", // new … Expression 23 | "keyword.control.flow.js", // await 24 | "keyword.control.conditional.js", // if 25 | "keyword.control.loop.js", // for 26 | "keyword.operator.new.js", // new 27 | ], 28 | "settings": { 29 | "fontStyle": "italic", 30 | }, 31 | }, 32 | { 33 | "scope": [ 34 | //following will be excluded from italics (My theme (Monokai dark) has some defaults I don't want to be in italics) 35 | "invalid", 36 | "keyword.operator", 37 | "constant.numeric.css", 38 | "keyword.other.unit.px.css", 39 | "constant.numeric.decimal.js", 40 | "constant.numeric.json", 41 | "entity.name.type.class.js" 42 | ], 43 | "settings": { 44 | "fontStyle": "", 45 | }, 46 | } 47 | ] 48 | }, 49 | "files.exclude": { 50 | "dist/": true, 51 | "doc/": true, 52 | "node_modules/": true, 53 | "package/": true, 54 | }, 55 | "alignment": { 56 | "operatorPadding": "right", 57 | "indentBase": "firstline", 58 | "surroundSpace": { 59 | "colon": [1, 1], // The first number specify how much space to add to the left, can be negative. The second number is how much space to the right, can be negative. 60 | "assignment": [1, 1], // The same as above. 61 | "arrow": [1, 1], // The same as above. 62 | "comment": 2, // Special how much space to add between the trailing comment and the code. 63 | // If this value is negative, it means don't align the trailing comment. 64 | } 65 | }, 66 | "editor.formatOnSave": false, 67 | "python.pythonPath": "python3", 68 | "eslint.validate": [ 69 | "javascript", 70 | "typescript", 71 | ], 72 | "cSpell.words": [ 73 | "Pipeable", 74 | "Serializable", 75 | "asciiart", 76 | "deserialization" 77 | ], 78 | 79 | } 80 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | - Merge pull request #8 from wechaty/dependabot/npm_and_yarn/yargs-17.0.0 2 | - Bump yargs from 16.2.0 to 17.0.0 3 | - add under construction infor 4 | - 0.1.6 5 | - add a stackoverflow rest explanation answer 6 | - 0.1.5 7 | - layout 8 | - 0.1.4 9 | - clean doc 10 | - 0.1.3 11 | - add swagger hub link 12 | - 0.1.2 13 | - add arch & screenshot 14 | - Merge branch 'main' of github.com:wechaty/openapi into main 15 | - add architecture 16 | - add usage 17 | - 0.1.1 18 | - publish 19 | - first workable proxy! 20 | - init mod 21 | - merge 22 | - add images & docs 23 | - Update README.md 24 | - Update README.md 25 | - add core os grpc gateway blog post from grpc.io 26 | - better logo & talk video link 27 | - init readme 28 | - Initial commit 29 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Guidelines for Contributing 2 | 3 | Thank you for your time on Wechaty OpenAPI. 4 | 5 | Check Wechaty contributing guidelines at [https://wechaty.js.org/docs/contributing/](https://wechaty.js.org/docs/contributing/). 6 | 7 | As an open-source product, Wechaty thrives on the contributions of community members. Whatever your skill set is, there is a lot you can do to help us make Wechaty better! 8 | So start forking! 9 | 10 | We built wechaty with pleasure because it can help others. Help from you for wechaty will be very much appreciated by the community. 11 | 12 | Cheers! 13 | 14 | Huan 15 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 |

Wechaty Puppet OpenAPI Specification (OAS)

5 |

6 | Wechaty REST API Server with OpenAPI Specification (Swagger) 7 |

8 | 10 | 11 | 12 | 13 |
14 | 15 |
16 | 17 |
18 | 19 |
20 | Table of Contents 21 |
    22 |
  1. About
    2. 23 |
  2. Motivation
    3. 24 |
  3. Screenshots
    4. 25 |
  4. Features
    5. 26 |
  5. Install
    6. 27 |
  6. 28 | Usage
    7. 29 | 34 |
  7. Architecture
    8. 35 |
  8. Resources
    9. 36 |
  9. Contributing
    10. 37 |
  10. Author
    11. 38 |
  11. Copyright & License
    12. 39 |
40 | 41 | ## About 42 | 43 | **OpenAPI Specification** (formerly Swagger Specification) is an API description format for REST APIs. An OpenAPI file allows you to describe your entire API, including: 44 | 45 | - Available endpoints (`/users`) and operations on each endpoint (`GET /users`, `POST /users`) 46 | - Operation parameters Input and output for each operation 47 | - Authentication methods 48 | - Contact information, license, terms of use, and other information. 49 | 50 | API specifications can be written in YAML or JSON. The format is easy to learn and readable to both humans and machines. The complete OpenAPI Specification can be found on GitHub: [OpenAPI 3.0 Specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) 51 | 52 | **NOTE:** 53 | 54 | > This repo is working in the process. 55 | > We hope we can finish an alpha version in April, 56 | > and be ready to Beta in May! 57 | 58 | > Issues & PRs are welcome, thank you very much for your attention. 59 | 60 | ## Motivation 61 | 62 | We have [OpenAPI](https://github.com/wechaty/openapi) for [Wechaty Puppet](https://github.com/wechaty/wechaty-puppet), and we want a RESTful API as well, so we built [OpenAPI Specification](https://www.openapis.org/) (OAS, former [Swagger](https://swagger.io/)) on top of gRPC, with the power of [gRPC OAS Gateway](https://github.com/grpc-ecosystem/grpc-gateway). 63 | 64 | ## Screenshots 65 | 66 |
67 | 68 |
69 | 70 |
71 | 72 | > [View Wechaty OpenAPI Specification on SwaggerHub](https://app.swaggerhub.com/apis/zixia/WechatyPuppet/) 73 | 74 | ## Features 75 | 76 | 1. A **Standalone HTTP Server** `wechaty-openapi-server` 77 | 2. An **Express Router** for easy mounting to any existing **Express HTTP Server**. 78 | 79 | ## Install 80 | 81 | ```sh 82 | npm install wechaty-openapi 83 | ``` 84 | 85 | ## Usage 86 | 87 | #### 1. Standalone Server 88 | 89 | ```sh 90 | export WECHATY_PUPPET_SERVICE_TOKEN=__YOUR_TOKEN__ 91 | wechaty-openapi-server \ 92 | --mountpoint /api 93 | --port 8080 94 | ``` 95 | 96 | Then visit 97 | 98 | #### 2. Express Router 99 | 100 | > TBW 101 | 102 | ## Architecture 103 | 104 | Thanks to the ecosystem of gRPC, we can generate OpenAPI Specification from our gRPC proto definitions automatically. 105 | 106 | We are using [gRPC to JSON proxy generator following the gRPC HTTP spec](https://github.com/grpc-ecosystem/grpc-gateway) as the OpenAPI Specification generator ([protoc-gen-openapiv2](https://github.com/grpc-ecosystem/grpc-gateway/tree/master/protoc-gen-openapiv2)), and using [Like grpc-gateway, but written in node and dynamic](https://github.com/konsumer/grpc-dynamic-gateway) project to serve an HTTP RESTful API to gRPC proxy. 107 | 108 |
109 | 110 | > Image credit: [gRPC Gateway](https://grpc-ecosystem.github.io/grpc-gateway/) 111 | 112 | Learn more about the RESTful API service for Wechaty from [Wechaty OpenAPI](https://github.com/wechaty/openapi). 113 | 114 | See also: [AIP-4222 - Routing headers](https://google.aip.dev/client-libraries/4222) 115 | 116 | ## Resources 117 | 118 | Read blogs with the `openapi` tag at https://wechaty.js.org/tags.html#openapi. 119 | 120 | Check out [RESOURCES.md](RESOURCES.md) file for learning resources. 121 | 122 | ## Contributing 123 | 124 | Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. 125 | 126 | 1. Fork the Project 127 | 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 128 | 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) 129 | 4. Push to the Branch (`git push origin feature/AmazingFeature`) 130 | 5. Open a Pull Request 131 | 132 | See [CONTRIBUTING.md](http://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md) for more details. 133 | 134 | ## Releases 135 | 136 | Since its creation in 2016, a number of Wechaty versions have been released. For more information about the release history and the current stable version, you can read the [Wechaty release notes](https://github.com/Wechaty/wechaty/releases) on Github. 137 | 138 | ## Maintainer 139 | 140 | Wechaty is maintained by [Huan](https://github.com/huan), [Rui](https://github.com/lijiarui), and a community of Open Source Contributors. We are always looking for people to join the Wechaty community to maintain the Wechaty codebase and documentation. You necessarily don't have to be a programmer to contribute to Wechaty. To get started contributing, you can read the [CONTRIBUTING.md](http://github.com/wechaty/openapi/blob/master/CONTRIBUTING.md). 141 | 142 | ## Getting help 143 | 144 | Wechaty has a community of very helpful contributors on different platforms you can join to get help from. Before joining any of the communities, we recommend that you read our Code of conduct]o that you adhere to our community guidelines. A full list of the different Wechaty communities can be accessed from the [Wechaty community](https://wechaty.js.org/docs/community/) section of this documentation. 145 | 146 | ## Copyright & License 147 | 148 | Wechaty is an [Open Source Project](https://opensource.com/resources/what-open-source). It is released under [Apache-2.0 license](https://github.com/wechaty/wechaty/blob/master/LICENSE) and the corresponding documentation is released under the [Creative Commons license](https://creativecommons.org/licenses/). 149 | -------------------------------------------------------------------------------- /RESOURCES.md: -------------------------------------------------------------------------------- 1 |
2 |

Wechaty Puppet OpenAPI Specification (OAS)

3 |

4 | Wechaty REST API Server with OpenAPI Specification (Swagger) 5 |

6 | Learning Resources 7 |

8 |
9 | 10 | ## gRPC 11 | 12 | - [探讨 gRPC 的 Node 技术生态及实现工具](https://xenojoshua.com/2018/02/grpc-node-ecosystem/) 13 | - [gRPC Basics - Node.js](https://grpc.io/docs/tutorials/basic/node.html) 14 | - [Building a gRPC service with Node.js](https://codelabs.developers.google.com/codelabs/cloud-grpc/) 15 | - [gRPC in 3 minutes (Node.js)](https://github.com/grpc/grpc/tree/master/examples/node) 16 | - [Listen gRPC and HTTP requests on the same port](https://medium.com/@drgarcia1986/listen-grpc-and-http-requests-on-the-same-port-263c40cb45ff) 17 | - [gRPC to JSON proxy generator following the gRPC HTTP spec](https://github.com/grpc-ecosystem/grpc-gateway) 18 | - [如何在 Node.js 中更优雅地使用 gRPC：grpc-helper](https://github.com/xizhibei/blog/issues/86) 19 | 20 | #### Documentation 21 | 22 | - [OpenAPI Specification v3.1](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md) 23 | - [gRPC with REST and Open APIs](https://grpc.io/blog/coreos/) 24 | - [OpenAPI Initiative Style Guide](https://github.com/OAI/OpenAPI-Style-Guide) 25 | 26 | #### Tools 27 | 28 | - [openapi2proto](https://github.com/NYTimes/openapi2proto) - A tool for generating Protobuf v3 schemas and gRPC service definitions from OpenAPI specifications 29 | - [OpenAPI.Tools](https://openapi.tools/) 30 | 31 | ## gRPC Web 32 | 33 | - [gRPC-Web: Moving past REST+JSON towards type-safe Web APIs](https://improbable.io/blog/grpc-web-moving-past-restjson-towards-type-safe-web-apis) 34 | - [Library for making gRPC-Web requests intended for TypeScript from either a browser or Node.js.](https://github.com/improbable-eng/grpc-web/tree/master/ts) 35 | 36 | ## Reverse Engineering 37 | 38 | - [A toolset for reverse engineering and fuzzing Protobuf-based apps](https://github.com/marin-m/pbtk) 39 | 40 | ### RESTful API Naming Convention 41 | 42 | - [REST Resource Naming Guide](https://restfulapi.net/resource-naming/) 43 | - [10+ Best Practices for Naming API Endpoints](https://nordicapis.com/10-best-practices-for-naming-api-endpoints/) 44 | - [PUT vs. POST in REST](https://stackoverflow.com/a/2590281/1123955) 45 | - [Google Cloud Common Design Patterns](https://cloud.google.com/apis/design/design_patterns) 46 | - [REST based Services/Architecture vs. RESTFUL Services/Architecture](https://stackoverflow.com/a/24584128/1123955) 47 | 48 | ### Tutorials 49 | 50 | - Talk video: [Writing REST Services for the gRPC curious, Johan Brandhorst, 2019, GopherCon UK](https://youtu.be/Pq1paKC-fXk) 51 | - [Take a REST with HTTP/2, Protobufs, and Swagger](https://coreos.com/blog/grpc-protobufs-swagger.html) 52 | - [All the boilerplate you need to get started with writing grpc-gateway powered REST services in Go](https://github.com/johanbrandhorst/grpc-gateway-boilerplate) 53 | -------------------------------------------------------------------------------- /bin/wechaty-openapi-server.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import fs from 'fs' 3 | 4 | import bodyParser from 'body-parser' 5 | import express from 'express' 6 | import grpc from 'grpc' 7 | import yargs from 'yargs' 8 | 9 | import { WechatyOpenApi } from '../src/mod' 10 | 11 | const argv = yargs.usage('Usage: $0 [options] DEFINITION.proto [DEFINITION2.proto...]') 12 | .help('?') 13 | .alias('?', 'help') 14 | .alias('?', 'h') 15 | 16 | .default('port', process.env.PORT || 8080) 17 | .describe('port', 'The port to serve your JSON proxy on') 18 | .alias('port', 'p') 19 | 20 | .describe('grpchost', 'The hostto connect to, where your gprc-server is running') 21 | .alias('grpchost', 'H') 22 | 23 | .describe('grpcport', 'The port to connect to, where your gprc-server is running') 24 | .alias('grpcport', 'P') 25 | 26 | .describe('I', 'Path to resolve imports from') 27 | .alias('I', 'include') 28 | 29 | .default('ca', '') 30 | .describe('ca', 'SSL CA cert for gRPC') 31 | .default('key', '') 32 | .describe('key', 'SSL client key for gRPC') 33 | .default('cert', '') 34 | .describe('cert', 'SSL client certificate for gRPC') 35 | 36 | .default('mountpoint', '/') 37 | .describe('mountpoint', 'URL to mount server on') 38 | .alias('mountpoint', 'm') 39 | 40 | .boolean('quiet') 41 | .describe('quiet', 'Suppress logs') 42 | .alias('quiet', 'q') 43 | 44 | .argv 45 | 46 | function main () { 47 | const protoFileList = argv._ as string[] 48 | 49 | if (!protoFileList.length) { 50 | yargs.showHelp() 51 | process.exit(1) 52 | } 53 | 54 | const protoPathList = argv.include as string[] 55 | 56 | const grpcHost = argv.grpchost as string ?? process.env.GRPC_HOST ?? 'localhost' 57 | const grpcPort = argv.grpcport 58 | ? parseInt(argv.grpcport as string) 59 | : process.env.GRPC_PORT 60 | ? parseInt(process.env.GRPC_PORT) 61 | : 50051 62 | 63 | let grpcCredentials 64 | if (argv.ca || argv.key || argv.cert) { 65 | if (!(argv.ca && argv.key && argv.cert)) { 66 | console.error('SSL requires --ca, --key, & --cert\n') 67 | yargs.showHelp() 68 | process.exit(1) 69 | } 70 | grpcCredentials = grpc.credentials.createSsl( 71 | fs.readFileSync(argv.ca), 72 | fs.readFileSync(argv.key), 73 | fs.readFileSync(argv.cert) 74 | ) 75 | } else { 76 | grpcCredentials = grpc.credentials.createInsecure() 77 | } 78 | 79 | const openApi = new WechatyOpenApi({ 80 | grpcCredentials, 81 | grpcHost, 82 | grpcPort, 83 | protoFileList, 84 | protoPathList, 85 | }) 86 | 87 | const app = express() 88 | app.use(bodyParser.json()) 89 | app.use(bodyParser.urlencoded({ extended: false })) 90 | app.use(argv.mountpoint, openApi.router()) 91 | 92 | app.listen(argv.port, () => { 93 | if (!argv.quiet) { 94 | console.info(`Listening on http://localhost:${argv.port}${argv.mountpoint}, proxying to gRPC on ${grpcHost}:${grpcPort}`) 95 | } 96 | }) 97 | } 98 | 99 | main() 100 | -------------------------------------------------------------------------------- /docs/images/grpc-gateway-architecture.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/images/grpc-rest-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wechaty/openapi/88f9ab0d0f5fc533074aeb7625f3d66c5c6ca458/docs/images/grpc-rest-logo.png -------------------------------------------------------------------------------- /docs/images/openapi.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wechaty/openapi/88f9ab0d0f5fc533074aeb7625f3d66c5c6ca458/docs/images/openapi.png -------------------------------------------------------------------------------- /docs/images/restful-grpc.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wechaty/openapi/88f9ab0d0f5fc533074aeb7625f3d66c5c6ca458/docs/images/restful-grpc.jpg -------------------------------------------------------------------------------- /docs/images/swagger.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wechaty/openapi/88f9ab0d0f5fc533074aeb7625f3d66c5c6ca458/docs/images/swagger.jpg -------------------------------------------------------------------------------- /docs/images/wechaty-openapi-logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /docs/images/wechaty-openapi-swagger-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wechaty/openapi/88f9ab0d0f5fc533074aeb7625f3d66c5c6ca458/docs/images/wechaty-openapi-swagger-ui.png -------------------------------------------------------------------------------- /docs/images/wechaty-openapi.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wechaty/openapi/88f9ab0d0f5fc533074aeb7625f3d66c5c6ca458/docs/images/wechaty-openapi.png -------------------------------------------------------------------------------- /examples/proxy.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | // import grpcGateway = require('grpc-dynamic-gateway') 4 | // const express = require('express') 5 | // const bodyParser = require('body-parser') 6 | 7 | // const app = express() 8 | // app.use(bodyParser.json()) 9 | // app.use(bodyParser.urlencoded({ extended: false })) 10 | 11 | // // load the proxy on / URL 12 | // app.use('/', grpcGateway(['api.proto'], '0.0.0.0:5051')) 13 | 14 | // const port = process.env.PORT || 8080 15 | // app.listen(port, () => { 16 | // console.log(`Listening on http://0.0.0.0:${port}`) 17 | // }) 18 | 19 | import fs from 'fs' 20 | 21 | import bodyParser from 'body-parser' 22 | import express from 'express' 23 | import grpc from 'grpc' 24 | import yargs from 'yargs' 25 | 26 | import { WechatyOpenApi } from '../src/mod' 27 | 28 | const argv = yargs.usage('Usage: $0 [options] DEFINITION.proto [DEFINITION2.proto...]') 29 | .help('?') 30 | .alias('?', 'help') 31 | .alias('?', 'h') 32 | 33 | .default('port', process.env.PORT || 8080) 34 | .describe('port', 'The port to serve your JSON proxy on') 35 | .alias('port', 'p') 36 | 37 | .describe('grpchost', 'The hostto connect to, where your gprc-server is running') 38 | .alias('grpchost', 'H') 39 | 40 | .describe('grpcport', 'The port to connect to, where your gprc-server is running') 41 | .alias('grpcport', 'P') 42 | 43 | .describe('I', 'Path to resolve imports from') 44 | .alias('I', 'include') 45 | 46 | .default('ca', '') 47 | .describe('ca', 'SSL CA cert for gRPC') 48 | .default('key', '') 49 | .describe('key', 'SSL client key for gRPC') 50 | .default('cert', '') 51 | .describe('cert', 'SSL client certificate for gRPC') 52 | 53 | .default('mountpoint', '/') 54 | .describe('mountpoint', 'URL to mount server on') 55 | .alias('mountpoint', 'm') 56 | 57 | .boolean('quiet') 58 | .describe('quiet', 'Suppress logs') 59 | .alias('quiet', 'q') 60 | 61 | .argv 62 | 63 | function main () { 64 | const protoFileList = argv._ as string[] 65 | 66 | if (!protoFileList.length) { 67 | yargs.showHelp() 68 | process.exit(1) 69 | } 70 | 71 | const protoPathList = argv.include as string[] 72 | 73 | const grpcHost = argv.grpchost as string ?? process.env.GRPC_HOST ?? 'localhost' 74 | const grpcPort = argv.grpcport 75 | ? parseInt(argv.grpcport as string) 76 | : process.env.GRPC_PORT 77 | ? parseInt(process.env.GRPC_PORT) 78 | : 50051 79 | 80 | let grpcCredentials 81 | if (argv.ca || argv.key || argv.cert) { 82 | if (!(argv.ca && argv.key && argv.cert)) { 83 | console.error('SSL requires --ca, --key, & --cert\n') 84 | yargs.showHelp() 85 | process.exit(1) 86 | } 87 | grpcCredentials = grpc.credentials.createSsl( 88 | fs.readFileSync(argv.ca), 89 | fs.readFileSync(argv.key), 90 | fs.readFileSync(argv.cert) 91 | ) 92 | } else { 93 | grpcCredentials = grpc.credentials.createInsecure() 94 | } 95 | 96 | const openApi = new WechatyOpenApi({ 97 | grpcCredentials, 98 | grpcHost, 99 | grpcPort, 100 | protoFileList, 101 | protoPathList, 102 | 103 | }) 104 | 105 | const app = express() 106 | app.use(bodyParser.json()) 107 | app.use(bodyParser.urlencoded({ extended: false })) 108 | app.use(argv.mountpoint, openApi.router()) 109 | 110 | app.listen(argv.port, () => { 111 | if (!argv.quiet) { 112 | console.info(`Listening on http://localhost:${argv.port}${argv.mountpoint}, proxying to gRPC on ${grpcHost}:${grpcPort}`) 113 | } 114 | }) 115 | } 116 | 117 | main() 118 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "wechaty-openapi", 3 | "version": "0.1.6", 4 | "description": "Wechaty Puppet RESTful API Service", 5 | "main": "dist/src/mod.js", 6 | "typings": "dist/src/mod.d.ts", 7 | "directories": { 8 | "doc": "docs" 9 | }, 10 | "bin": { 11 | "wechaty-openapi-server": "dist/bin/wechaty-openapi-server.js" 12 | }, 13 | "scripts": { 14 | "clean": "shx rm -fr dist/*", 15 | "dist": "npm run clean && tsc", 16 | "example": "ts-node examples/proxy.ts", 17 | "lint": "npm run lint:es && npm run lint:ts", 18 | "lint:ts": "tsc --noEmit", 19 | "pack": "npm pack", 20 | "test": "npm run lint && npm run test:unit", 21 | "test:unit": "blue-tape -r ts-node/register \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"", 22 | "test:pack": "bash -x scripts/npm-pack-testing.sh", 23 | "lint:es": "eslint --ignore-pattern fixtures/ \"src/**/*.ts\" \"tests/**/*.ts\"" 24 | }, 25 | "repository": { 26 | "type": "git", 27 | "url": "git+https://github.com/wechaty/openapi.git" 28 | }, 29 | "keywords": [ 30 | "wechaty", 31 | "openapi", 32 | "grpc", 33 | "wechaty-openapi", 34 | "restful" 35 | ], 36 | "author": "Huan ", 37 | "license": "Apache-2.0", 38 | "bugs": { 39 | "url": "https://github.com/wechaty/openapi/issues" 40 | }, 41 | "homepage": "https://github.com/wechaty/openapi#readme", 42 | "devDependencies": { 43 | "@chatie/eslint-config": "^0.14.1", 44 | "@chatie/git-scripts": "^0.6.2", 45 | "@chatie/semver": "^0.4.7", 46 | "@chatie/tsconfig": "^0.20.2", 47 | "@types/express": "^4.17.11", 48 | "@types/yargs": "^17.0.2", 49 | "shx": "^0.3.3", 50 | "tstest": "^0.4.10" 51 | }, 52 | "dependencies": { 53 | "body-parser": "^1.19.0", 54 | "brolog": "^1.12.4", 55 | "express": "^4.17.1", 56 | "grpc": "^1.24.5", 57 | "grpc-dynamic-gateway": "^0.4.4", 58 | "yargs": "^17.0.0" 59 | }, 60 | "publishConfig": { 61 | "access": "public", 62 | "tag": "next" 63 | }, 64 | "git": { 65 | "scripts": { 66 | "pre-push": "npx git-scripts-pre-push" 67 | } 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /scripts/generate-version.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | SRC_VERSION_TS_FILE='src/version.ts' 5 | 6 | [ -f ${SRC_VERSION_TS_FILE} ] || { 7 | echo ${SRC_VERSION_TS_FILE}" not found" 8 | exit 1 9 | } 10 | 11 | VERSION=$(npx pkg-jq -r .version) 12 | 13 | cat <<_SRC_ > ${SRC_VERSION_TS_FILE} 14 | /** 15 | * This file was auto generated from scripts/generate-version.sh 16 | */ 17 | export const VERSION: string = '${VERSION}' 18 | _SRC_ 19 | 20 | echo "$VERSION generated." 21 | -------------------------------------------------------------------------------- /scripts/npm-pack-testing.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | 5 | npm run dist 6 | npm run pack 7 | 8 | TMPDIR="/tmp/npm-pack-testing.$$" 9 | mkdir "$TMPDIR" 10 | mv *-*.*.*.tgz "$TMPDIR" 11 | cp tests/fixtures/smoke-testing.ts "$TMPDIR" 12 | 13 | cd $TMPDIR 14 | npm init -y 15 | npm install *-*.*.*.tgz \ 16 | @types/node \ 17 | typescript@latest 18 | 19 | ./node_modules/.bin/tsc \ 20 | --lib esnext,dom \ 21 | --noEmitOnError \ 22 | --noImplicitAny \ 23 | --skipLibCheck \ 24 | smoke-testing.ts 25 | 26 | node smoke-testing.js 27 | -------------------------------------------------------------------------------- /scripts/package-publish-config-tag.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | 4 | VERSION=$(npx pkg-jq -r .version) 5 | 6 | if npx --package @chatie/semver semver-is-prod $VERSION; then 7 | npx pkg-jq -i '.publishConfig.tag="latest"' 8 | echo "production release: publicConfig.tag set to latest." 9 | else 10 | npx pkg-jq -i '.publishConfig.tag="next"' 11 | echo 'development release: publicConfig.tag set to next.' 12 | fi 13 | 14 | -------------------------------------------------------------------------------- /src/config.ts: -------------------------------------------------------------------------------- 1 | /// 2 | 3 | import { Brolog } from 'brolog' 4 | 5 | function getLog () { 6 | const log = Brolog.instance() 7 | 8 | const logLevel = process.env.WECHATY_LOG 9 | if (logLevel) { 10 | log.level(logLevel.toLowerCase() as any) 11 | log.silly('WechatyOpenAPI', 'Config: WECHATY_LOG set level to %s', logLevel) 12 | } 13 | 14 | return log 15 | } 16 | 17 | const log = getLog() 18 | 19 | export { log } 20 | export { VERSION } from './version' 21 | -------------------------------------------------------------------------------- /src/mod.ts: -------------------------------------------------------------------------------- 1 | export { 2 | VERSION, 3 | } from './version' 4 | 5 | export { 6 | WechatyOpenApi, 7 | } from './openapi' 8 | -------------------------------------------------------------------------------- /src/openapi.spec.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ts-node 2 | 3 | import { test } from 'tstest' 4 | 5 | import { WechatyOpenApi } from './openapi' 6 | 7 | test('WechatyOpenApi smoke testing', async (t) => { 8 | const openApi = new WechatyOpenApi({ 9 | grpcCredentials: {} as any, 10 | grpcHost: '', 11 | grpcPort: 0, 12 | protoFileList: [], 13 | protoPathList: [], 14 | }) 15 | t.ok(openApi, 'should instanciate successfully') 16 | }) 17 | -------------------------------------------------------------------------------- /src/openapi.ts: -------------------------------------------------------------------------------- 1 | import express from 'express' 2 | import grpc from 'grpc' 3 | import grpcGateway from 'grpc-dynamic-gateway' 4 | 5 | import { log } from './config' 6 | 7 | interface WechatyOpenApiOptions { 8 | grpcCredentials : grpc.ChannelCredentials, 9 | grpcHost : string, 10 | grpcPort : number, 11 | protoFileList : string[], 12 | protoPathList : string[], 13 | } 14 | 15 | /** 16 | * Express Routing: https://expressjs.com/en/guide/routing.html 17 | */ 18 | class WechatyOpenApi { 19 | 20 | static VERSION = '0.0.0' 21 | 22 | constructor ( 23 | private options: WechatyOpenApiOptions, 24 | ) { 25 | log.verbose('WechatyOpenApi', 'constructor(%s)', JSON.stringify(options)) 26 | } 27 | 28 | version (): string { 29 | return '0.0.0' 30 | } 31 | 32 | router (): express.Router { 33 | log.verbose('WechatyOpenApi', 'router()') 34 | 35 | const debug = ['verbose', 'silly', 'info'].includes(log.level()) 36 | const options = this.options 37 | 38 | const middleware = grpcGateway( 39 | options.protoFileList, 40 | `${options.grpcHost}:${options.grpcPort}`, 41 | options.grpcCredentials, 42 | debug, 43 | options.protoPathList, 44 | ) 45 | 46 | return middleware 47 | } 48 | 49 | } 50 | 51 | export { WechatyOpenApi } 52 | -------------------------------------------------------------------------------- /src/typings.d.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Typings for un-typed modle 3 | */ 4 | declare module 'grpc-dynamic-gateway' { 5 | import express from 'express' 6 | import grpc from 'grpc' 7 | 8 | function grpcGateway ( 9 | protoFileList : string[], 10 | grpcEndpoint : string, 11 | credentials : grpc.ChannelCredentials, 12 | debug : boolean, 13 | include : string | string[], 14 | ): express.Router 15 | 16 | export default grpcGateway 17 | } 18 | -------------------------------------------------------------------------------- /src/version.spec.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ts-node 2 | 3 | import { test } from 'tstest' 4 | 5 | import { VERSION } from './version' 6 | 7 | test('Make sure the VERSION is fresh in source code', async (t) => { 8 | t.equal(VERSION, '0.0.0', 'version should be 0.0.0 in source code, only updated before publish to NPM') 9 | }) 10 | -------------------------------------------------------------------------------- /src/version.ts: -------------------------------------------------------------------------------- 1 | 2 | /** 3 | * This file will be overwrite when we publish NPM module 4 | * by scripts/generate_version.ts 5 | */ 6 | 7 | export const VERSION = '0.0.0' 8 | -------------------------------------------------------------------------------- /tests/fixtures/smoke-testing.ts: -------------------------------------------------------------------------------- 1 | import { 2 | WechatyOpenApi, 3 | VERSION, 4 | } from 'wechaty-openapi' 5 | 6 | if (VERSION as any === '0.0.0') { 7 | throw new Error('version not set right before publish!') 8 | } 9 | 10 | const openApi = new WechatyOpenApi({ 11 | grpcCredentials: {} as any, 12 | grpcHost: '', 13 | grpcPort: 0, 14 | protoFileList: [], 15 | protoPathList: [], 16 | }) 17 | console.info(`WechatyOpenApi v${openApi.version()} package smoke testing passed!`) 18 | -------------------------------------------------------------------------------- /tests/integration.spec.ts: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ts-node 2 | 3 | import { test } from 'tstest' 4 | 5 | // import { OpenApi } from '../src/mod' 6 | 7 | test('integration', async (t) => { 8 | t.pass('to-be written') 9 | }) 10 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "@chatie/tsconfig", 3 | "compilerOptions": { 4 | "outDir": "dist", 5 | }, 6 | "exclude": [ 7 | "node_modules/", 8 | "dist/", 9 | "tests/fixtures/", 10 | ], 11 | "include": [ 12 | "app/**/*.ts", 13 | "bin/*.ts", 14 | "bot/**/*.ts", 15 | "examples/**/*.ts", 16 | "scripts/**/*.ts", 17 | "src/**/*.ts", 18 | "tests/**/*.spec.ts", 19 | ], 20 | } 21 | --------------------------------------------------------------------------------