{"id":13672700,"url":"https://github.com/hughfenghen/ts-rpc","last_synced_at":"2025-07-15T15:41:52.487Z","repository":{"id":45226746,"uuid":"414898026","full_name":"hughfenghen/ts-rpc","owner":"hughfenghen","description":"以 RPC 风格调用 TypeScript 编写的服务端接口，扫描源码生成dts，无需手写额外的类型代码","archived":false,"fork":false,"pushed_at":"2023-08-10T10:51:55.000Z","size":502,"stargazers_count":13,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-18T18:04:05.838Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/hughfenghen.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-10-08T08:00:23.000Z","updated_at":"2025-05-30T05:29:28.000Z","dependencies_parsed_at":"2024-01-17T04:18:35.832Z","dependency_job_id":null,"html_url":"https://github.com/hughfenghen/ts-rpc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hughfenghen/ts-rpc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hughfenghen%2Fts-rpc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hughfenghen%2Fts-rpc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hughfenghen%2Fts-rpc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hughfenghen%2Fts-rpc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hughfenghen","download_url":"https://codeload.github.com/hughfenghen/ts-rpc/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hughfenghen%2Fts-rpc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260606446,"owners_count":23035348,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-08-02T09:01:44.732Z","updated_at":"2025-06-18T18:04:32.142Z","avatar_url":"https://github.com/hughfenghen.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# ts-brpc\n\n`ts-brpc`支持以 RPC 风格调用 TypeScript 编写的服务端接口，让开发者专注业务实现。  \n\n## 特性\n- `ts-brpc`让客户端以 RPC 风格调用接口，函数调用是程序最自然的通信方式，免去手动构造 HTTP 请求。  \n- `ts-brpc`可以扫描服务端 TS 代码中的类型信息，可在编码时为客户端提供类型校验、代码补全、接口注释；代码即 API 文档。  \n- `ts-brpc`借由扫描获得的类型信息，零成本支持自动生成接口 Mock 数据的能力。  \n- `ts-brpc`由 CLI + SDK 组成，运行时（SDK）非常轻量，可与 Koa、Midway.js 快速集成。  \n\n## 示例展示\n\n### Server\n```ts\nimport { RPCMethod, RPCService } from 'ts-brpc/server'\n\ninterface UserInfo {\n  id: string\n  name: string\n  age: number\n}\n\n@RPCService()\nexport class User {\n\n  @RPCMethod()\n  getInfoById (id: string): UserInfo {\n    return { id, name: '22', age: 18 }\n  }\n\n  @RPCMethod()\n  getUnreadMsg (id: string): Promise\u003cstring[]\u003e {\n    // 模拟异步调用\n    return Promise.resolve(['msg1', 'msg2'])\n  }\n}\n```\n\n### Client\n```ts\nimport { createRemoteService } from 'ts-brpc/client'\n// ts-brpc 扫描服务端代码生成的 rpc-definition.ts\nimport { App } from './rpc-definition'\n\nconst rpc = createRemoteService\u003cApp\u003e({\n  baseUrl: '\u003cweb app base url\u003e'\n})\n\nawait rpc.User.getInfoById('22') // =\u003e { id: '22', name: '22', age: 18 }\n```\n\n\n### 运行 demo\n1. `git clone git@github.com:hughfenghen/ts-rpc.git`  \n2. `yarn \u0026\u0026 yarn build`\n3. `cd demo \u0026\u0026 yarn`  \n4. `yarn server` 然后新开 shell 窗口 `yarn client`  \n\n## 文档\n- [接入指南](./docs/guide.md)\n- [API](./docs/api.md)\n- [工作原理](./docs/design.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhughfenghen%2Fts-rpc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhughfenghen%2Fts-rpc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhughfenghen%2Fts-rpc/lists"}