{"id":22693629,"url":"https://github.com/jadepeng/generator-swagger-2-ts","last_synced_at":"2026-03-01T22:37:54.780Z","repository":{"id":31944932,"uuid":"130944262","full_name":"jadepeng/generator-swagger-2-ts","owner":"jadepeng","description":" A Swagger Codegen for typescript and javascript","archived":false,"fork":false,"pushed_at":"2023-01-05T12:54:27.000Z","size":1011,"stargazers_count":78,"open_issues_count":22,"forks_count":20,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-24T19:56:28.093Z","etag":null,"topics":["javascript","swagger-codegen","typescript"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jadepeng.png","metadata":{"files":{"readme":"README.cn.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-25T03:14:16.000Z","updated_at":"2025-02-26T02:35:39.000Z","dependencies_parsed_at":"2023-01-14T20:15:38.138Z","dependency_job_id":null,"html_url":"https://github.com/jadepeng/generator-swagger-2-ts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jadepeng/generator-swagger-2-ts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadepeng%2Fgenerator-swagger-2-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadepeng%2Fgenerator-swagger-2-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadepeng%2Fgenerator-swagger-2-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadepeng%2Fgenerator-swagger-2-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jadepeng","download_url":"https://codeload.github.com/jadepeng/generator-swagger-2-ts/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jadepeng%2Fgenerator-swagger-2-ts/sbom","scorecard":{"id":501728,"data":{"date":"2025-08-11","repo":{"name":"github.com/jadepeng/generator-swagger-2-ts","commit":"7d062b4adf3d0d2cf5050c8ad864997eb9ccc534"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/17 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":0,"reason":"99 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-hr2v-3952-633q","Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q","Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44","Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-8g7p-74h8-hg48","Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3","Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-446m-mv8f-q348","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jv35-xqg7-f92r","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh","Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-42xw-2xvc-qx8m","Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2","Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr","Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6","Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9","Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f","Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p","Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv","Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8","Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65","Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T22:05:19.183Z","repository_id":31944932,"created_at":"2025-08-19T22:05:19.183Z","updated_at":"2025-08-19T22:05:19.183Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29987367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T21:06:37.093Z","status":"ssl_error","status_checked_at":"2026-03-01T21:05:45.052Z","response_time":124,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","swagger-codegen","typescript"],"created_at":"2024-12-10T02:12:06.409Z","updated_at":"2026-03-01T22:37:54.764Z","avatar_url":"https://github.com/jadepeng.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-swagger-2-ts [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]\n\u003e \n\n一款基于 [Yeoman](http://yeoman.io)的swagger js/typescript代码生成器 ，借助这个软件包，可以生成一个访问swagger api 的js/typescript类.\n\n## 安装\n\n需要同时安装 [Yeoman](http://yeoman.io) 和 -swagger-2-ts\n\n```bash\nnpm install -g yo\nnpm install -g generator-swagger-2-ts\n```\n\n然后cd到你的工作目录，执行:\n\n```bash\nyo swagger-2-ts\n```\n\n\n按提示\n- 输入swagger-ui 地址，例如http://192.168.86.8:8051/swagger-ui.html，程序包会自动将这个url地址replace('swagger-ui.html', 'v2/api-docs')得到swagger-api-docs，然后下载后解析，生成api class\n- 可选生成js 或者 typescript\n- 可以自定义生成的api class名称、api文件名\n- API 支持泛型\n\n\n可以通过命令行直接传递参数\n\n```bash\n yo swagger-2-ts --swaggerUrl=http://localhost:8080/swagger-ui.html --className=API --type=typescript --outputFile=api.ts\n```\n\n- swaggerUrl: swagger ui url swaggerui地址\n- className： API class name 类名\n- type： typescript or javascipt \n- outputFile: api 文件保存路径\n\n\n\n## 生成代码demo：\n\n```javascript\n\nexport type AccountUserInfo = {\n  disableTime?: string\n  isDisable?: number\n  lastLoginIp?: string\n  lastLoginPlace?: string\n  lastLoginTime?: string\n  openId?: string\n}\n\n\nexport type BasePayloadResponse = {\n  data?: object\n  desc?: string\n  retcode?: string\n\n}\n\n/**\n * User Account Controller\n * @class UserAccountAPI\n */\nexport class UserAccountAPI {\n/**\n  * changeUserState\n  * @method\n  * @name UserAccountAPI#changeUserState\n  \n  * @param  accountUserInfo - accountUserInfo \n  \n  * @param $domain API域名,没有指定则使用构造函数指定的\n  */\n  changeUserState(parameters: {\n    'accountUserInfo': AccountUserInfo,\n    $queryParameters?: object,\n    $domain?: string\n  }): Promise\u003cAxiosResponse\u003cBasePayloadResponse\u003e\u003e {\n\n    let config: AxiosRequestConfig = {\n      baseURL: parameters.$domain || this.$defaultDomain,\n      url: '/userAccount/changeUserState',\n      method: 'PUT'\n    }\n\n    config.headers = {}\n    config.params = {}\n\n    config.headers[ 'Accept' ] = '*/*'\n    config.headers[ 'Content-Type' ] = 'application/json'\n\n    config.data = parameters.accountUserInfo\n    return axios.request(config)\n  }\n\n/**\n  * changeUserState\n  * @method\n  * @name UserAccountAPI#changeUserState\n  \n  * @param  accountUserInfo - accountUserInfo \n  \n  * @param $domain API域名,没有指定则使用构造函数指定的\n  */\n  async changeUserStateAsync(parameters: {\n    'accountUserInfo': AccountUserInfo,\n    $queryParameters?: object,\n    $domain?: string\n  }): Promise\u003cBasePayloadResponse\u003e {\n\n    let resp = await this.changeUserStateAsync(parameters);\n    return Promise.resolve(resp.data);\n  }\n\n}\n\n\n/**\n * 管理系统接口描述\n * @class API\n */\nexport class API {\n  /**\n   *  API构造函数\n   * @param domain API域名\n   */\n  constructor(domain?: string) {\n    this.$defaultDomain = domain || 'http://localhost:8080'\n  }\n\n  _UserAccountAPI: UserAccountAPI = null;\n\n  /**\n  * 获取 User Account Controller API\n  * return @class UserAccountAPI\n  */\n  getUserAccountAPI(): UserAccountAPI {\n    if (!this._UserAccountAPI) {\n      this._UserAccountAPI = new UserAccountAPI(this.$defaultDomain)\n    }\n    return this._UserAccountAPI\n  }\n}\n\n```\n\n## 使用\n\n```javascript\n\nimport { API } from './api'\n\nlet api = new API('YOUR_API_HOST')\n// add Header Authorization\napi.withAuthorization(\"YOUR_TOKEN\")\n// add Interceptors\napi.withInterceptors(\n    response =\u003e {\n        if (response.status === 200) {\n            return Promise.resolve(response)\n        } else {\n            return Promise.reject(response)\n        }\n    },\n    error =\u003e {\n        if (error.response.status) {\n            switch (error.response.status) {\n                // 401: 未登录\n                case 401:\n                    console.error(\"身份验证失败，请关闭重新进入。\")\n                    break\n                // 403 token过期\n                case 403:\n                    console.error(\"登录过期，请关闭重新进入。\")\n                    break\n                // 404请求不存在\n                case 404:\n                    console.error(\"您访问的网页不存在。\")\n                    break\n                // 其他错误，直接抛出错误提示\n                default:\n                    console.error(error.response.data.message)\n            }\n            return Promise.reject(error.response)\n        }\n    })\n\n\n// in main.ts\napi.getUserAccountAPI().changeUserState({\n  isDisable: 1\n  openId: 'open id'\n}).then(resp=\u003e{\n  console.log(resp)\n})\n```\n\n## Getting To Know Yeoman\n\n * Yeoman has a heart of gold.\n * Yeoman is a person with feelings and opinions, but is very easy to work with.\n * Yeoman can be too opinionated at times but is easily convinced not to be.\n * Feel free to [learn more about Yeoman](http://yeoman.io/).\n\n ## 参考\n\n - [swagger-js-codegen](https://github.com/wcandillon/swagger-js-codegen)\n\n## License\n\nApache-2.0 © [jadepeng]()\n\n\n[npm-image]: https://badge.fury.io/js/generator-swagger-2-ts.svg\n[npm-url]: https://npmjs.org/package/generator-swagger-2-ts\n[travis-image]: https://travis-ci.org/jadepeng/generator-swagger-2-ts.svg?branch=master\n[travis-url]: https://travis-ci.org/jadepeng/generator-swagger-2-ts\n[daviddm-image]: https://david-dm.org/jadepeng/generator-swagger-2-ts.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/jadepeng/generator-swagger-2-ts\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadepeng%2Fgenerator-swagger-2-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjadepeng%2Fgenerator-swagger-2-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjadepeng%2Fgenerator-swagger-2-ts/lists"}