{"id":19506318,"url":"https://github.com/thenorthmemory/dubbo-swagger","last_synced_at":"2026-01-30T21:37:32.704Z","repository":{"id":57216908,"uuid":"155069044","full_name":"TheNorthMemory/dubbo-swagger","owner":"TheNorthMemory","description":"the dubbo rpc services and the swagger integration","archived":false,"fork":false,"pushed_at":"2018-10-31T14:42:01.000Z","size":18,"stargazers_count":1,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-04T15:43:10.734Z","etag":null,"topics":["dubbo","node-dubbo","openapi","swagger","swagger-ui","yaml"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TheNorthMemory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-28T12:32:49.000Z","updated_at":"2019-06-21T01:45:03.000Z","dependencies_parsed_at":"2022-08-28T21:01:40.453Z","dependency_job_id":null,"html_url":"https://github.com/TheNorthMemory/dubbo-swagger","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/TheNorthMemory/dubbo-swagger","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNorthMemory%2Fdubbo-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNorthMemory%2Fdubbo-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNorthMemory%2Fdubbo-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNorthMemory%2Fdubbo-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheNorthMemory","download_url":"https://codeload.github.com/TheNorthMemory/dubbo-swagger/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheNorthMemory%2Fdubbo-swagger/sbom","scorecard":{"id":140298,"data":{"date":"2025-08-11","repo":{"name":"github.com/TheNorthMemory/dubbo-swagger","commit":"a31d06141fc49badaebe8939c84103f5c76dd832"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"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":"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":"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":"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":"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":"Code-Review","score":0,"reason":"Found 0/8 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":"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":"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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":"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"}}]},"last_synced_at":"2025-08-16T07:52:12.619Z","repository_id":57216908,"created_at":"2025-08-16T07:52:12.619Z","updated_at":"2025-08-16T07:52:12.619Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28919749,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T20:25:28.696Z","status":"ssl_error","status_checked_at":"2026-01-30T20:25:13.426Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: 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":["dubbo","node-dubbo","openapi","swagger","swagger-ui","yaml"],"created_at":"2024-11-10T22:36:39.340Z","updated_at":"2026-01-30T21:37:32.688Z","avatar_url":"https://github.com/TheNorthMemory.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DUBBO SWAGGER\n\n[![NPM version](https://badge.fury.io/js/dubbo-swagger.svg)](http://badge.fury.io/js/dubbo-swagger)\n[![npm module downloads per month](http://img.shields.io/npm/dm/dubbo-swagger.svg)](https://www.npmjs.org/package/dubbo-swagger)\n\n[English Version](README_en-US.md)\n\n得益于开源项目 [OpenAPI-Specification](https://github.com/OAI/OpenAPI-Specification) 及 [node-dubbo](https://www.npmjs.com/package/dubbo)，使用纯JavaScript远程消费 [DUBBO](https://dubbo.io) 服务。\n\n## 项目结构\n\n```\n├── api\n│   ├── any_validFolder-com.foo.interface\n│   │   ├── complex.yaml\n│   │   ├── minus.yaml\n│   │   ├── plus.yaml\n│   │   └── meta.json\n├── bin\n│   └── flush.js\n├── index.js\n├── lib\n│   ├── consumer.js\n│   └── descriptor.js\n├── package.json\n└── static\n    ├── index.html\n    ├── swagger.json\n    └── swagger.yaml\n```\n\n## 环境变量\n\n- `process.env.ZKADDR`\n\n  \u003e zookeeper 注册中心地址，如未设置，http服务仅能当作接口文档，无法发起有效RPC调用\n\n- `process.env.PORT || 3030`\n\n  \u003e koa http server 监听端口\n\n- `process.env.CLUSTERNUM || 1`\n\n  \u003e nodejs cluster 进程数目，windows 平台默认为1，*nix 平台默认为 CPU 核数\n\n- `process.env.OAI_EXT_FLAT || 'x-flat'`\n\n  \u003e OAS 扩展key，声明入参是扁平入参\n\n- `process.env.OAI_EXT_OBJECT || 'x-object'`\n\n  \u003e OAS 扩展key，声明入参(有且只有1个入参)是对象入参\n\n- `process.env.OAI_EXT_MAP_KEY || 'x-key'`\n\n  \u003e OAS 扩展key，声明入参如果是Map对象，map-key的数据类型描述\n\n- `process.env.OAI_ARRAY_COLLECTION || ','`\n\n  \u003e OAS 默认array类型分隔符\n\n- `process.env.APPHOST || 'dubbo.io'`\n\n  \u003e `bin/flush.js` 生成文档时的默认主机地址\n\n- `process.env.NO_WRITE`\n\n  \u003e 如设置此变量，`bin/flush.js` 仅校验yaml语法是否正确，不写入最终 `static/swagger.*`\n\n## `bin/flush.js`\n\n作用是把目录 `api/*/*.yaml` 文件组合生成为 `static/swagger.*` 文件\n\n## `lib/consumer.js`\n\ndubbo consumer wrapper\n\n### `lib/descriptor.js`\n\n入参转换核心部件，把 HTTP POST (`ctx.request.fields`) 转换成 [hessian.js](https://www.npmjs.com/package/hessian.js) 入参\n\n### `index.js`\n\nHTTP 入口，路由监听 `/providers/:serviceName/:serviceMethod` 消费 DUBBO RPC 服务\n\n### `static/index.html`\n\nswagger-ui 入口\n\n## `api/*/meta.json`\n- interface\n- timeout\n- group\n- version\n- tags\n  \u003e 扩展的 swagger UI 标签，Array[String] 结构\n\n## 基础OAS数据结构与 [js-to-java](https://www.npmjs.com/package/js-to-java) 类型映射\n\n```json\n    'boolean'                : java.Boolean,\n    'string'                 : java.String,\n    'string_byte'            : java.Byte,\n    'string_date'            : java.Date,\n    'string_date-time'       : java.Date,\n    'number'                 : java.int,\n    'number_float'           : java.Float,\n    'number_double'          : java.Double,\n    'integer'                : java.Integer,\n    'integer_int64'          : java.Long,\n\n    'object_map'             : java.Map,\n\n    'array_boolean'          : java.array.Boolean,\n    'array_string'           : java.array.String,\n    'array_string_byte'      : java.array.Byte,\n    'array_string_date'      : java.array.Date,\n    'array_string_date-time' : java.array.Date,\n    'array_number'           : java.array.int,\n    'array_number_float'     : java.array.Float,\n    'array_number_double'    : java.array.Double,\n    'array_integer'          : java.array.Integer,\n    'array_integer_int64'    : java.array.Long,\n```\n\n## 示例\n\napi/any_validFolder-com.foo.interface/meta.json\n\n```json\n{\n    \"interface\": \"com.foo.interface\",\n    \"timeout\": 100,\n    \"tags\": [\n        \"Math测试\"\n    ]\n}\n```\n\napi/any_validFolder-com.foo.interface/plus.yaml\n\n```yaml\nsummary: 'a+b=?'\nx-object: com.foo.rpc.plus\nparameters:\n  - name: a\n    in: formData\n    type: integer\n    format: int32\n  - name: b\n    in: formData\n    type: integer\n    format: int32\nresponses:\n  '200':\n    description: ''\n```\n\napi/any_validFolder-com.foo.interface/minus.yaml\n\n\n```yaml\nsummary: 'a-b=?'\nx-flat: true\nparameters:\n  - name: a\n    in: formData\n    type: integer\n    format: int32\n  - name: b\n    in: formData\n    type: integer\n    format: int32\nresponses:\n  '200':\n    description: ''\n```\n\napi/any_validFolder-com.foo.interface/complex.yaml\n\n```yaml\nsummary: 'complex request'\nx-object: com.foo.rpc.complex\nparameters:\n  - name: a\n    in: formData\n    type: integer\n    format: int64\n    required: true\n  - name: b\n    in: formData\n    type: string\n    required: true\n  - name: c\n    in: formData\n    type: array\n    items:\n      type: string\n  - name: d\n    in: formData\n    type: object\n    additionalProperties:\n      x-key:\n        type: string\n      type: string\n  - name: e\n    in: formData\n    type: array\n    items:\n      type: integer\n      format: int64\n  - name: f\n    type: number\n    nullable: true\n    format: double\n  - name: g\n    nullable: true\n    type: integer\n  - name: h\n    nullable: true\n    type: number\n    format: float\n  - name: i\n    in: formData\n    nullable: true\n    type: array\n    items:\n      type: object\n      x-object: io.dubbo.model.one\n      properties:\n        J:\n          type: integer\n          format: int64\n        K:\n          type: string\n        L:\n          type: array\n          items:\n            type: string\n        M:\n          type: object\n          x-object: io.dubbo.model.two\n          properties:\n            N:\n              type: string\n            O:\n              type: integer\n              format: int64\n  - name: p\n    in: formData\n    type: integer\n    format: int64\n    default: '0'\n```\n\n## 安装依赖\n\n`npm install`\n\n## 运行\n\n`ZKADDR=127.0.0.1:2181 DEBUG=dubbo:* CLUSTERNUM=1 NO_DEPRECATION=koa node index.js`\n\n打开浏览器访问 `http://127.0.0.1:3030` 即可看到 swagger ui 提供的基础参数界面；使用 `Try it out` 可以发起正常的表单输入；使用 `Execute` 即可发起dubbo RPC调用。\n\n## Licensing\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenorthmemory%2Fdubbo-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthenorthmemory%2Fdubbo-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthenorthmemory%2Fdubbo-swagger/lists"}