{"id":19442134,"url":"https://github.com/ackeecz/grpc-server-reflection","last_synced_at":"2025-04-25T00:31:23.283Z","repository":{"id":57254491,"uuid":"446810757","full_name":"AckeeCZ/grpc-server-reflection","owner":"AckeeCZ","description":"gRPC server reflection for Node.js","archived":true,"fork":false,"pushed_at":"2024-10-31T06:20:42.000Z","size":19,"stargazers_count":24,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-24T00:01:58.757Z","etag":null,"topics":["descriptor-set","grpc","introspection","nodejs","proto","reflection","server","service"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AckeeCZ.png","metadata":{"files":{"readme":"README.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-11T12:23:27.000Z","updated_at":"2024-10-31T06:21:22.000Z","dependencies_parsed_at":"2024-06-18T21:36:31.928Z","dependency_job_id":"39ca2526-a56f-4e7e-b19a-759e79103105","html_url":"https://github.com/AckeeCZ/grpc-server-reflection","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"2a33ccb619824f59377606e27d4759d57be4fa94"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AckeeCZ%2Fgrpc-server-reflection","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AckeeCZ%2Fgrpc-server-reflection/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AckeeCZ%2Fgrpc-server-reflection/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AckeeCZ%2Fgrpc-server-reflection/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AckeeCZ","download_url":"https://codeload.github.com/AckeeCZ/grpc-server-reflection/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250732729,"owners_count":21478218,"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":["descriptor-set","grpc","introspection","nodejs","proto","reflection","server","service"],"created_at":"2024-11-10T15:38:22.657Z","updated_at":"2025-04-25T00:31:23.002Z","avatar_url":"https://github.com/AckeeCZ.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ⚠️ grpc-server-reflection\n\n---\n\n\u003e **⚠️ This repository is no longer maintained and has been archived for reference purposes.**\n\n### 📌 Important Notes:\n- **🚫 No further updates** will be made.\n- **🛑 Issues and pull requests** are no longer monitored.\n- **⚠️ Use at your own risk** as the code may not meet current standards or may contain vulnerabilities.\n\nFor continued use, please **consider forking this repository**.\n\n🙏 Thank you for your interest in this project!\n\n---\n\ngRPC [server reflection](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) for Node.js.\n\n\nUsing the reflection on your server allows your clients to get information regarding available RPCs and their format without actually having the schema definition.\n\nWith reflection you can use tools like [grpcurl](https://github.com/fullstorydev/grpcurl) or [wombat](https://github.com/rogchap/wombat) to call and test the API without linking the schema files, but just by accessing the live server.\n\n[![](https://flat.badgen.net/npm/v/grpc-server-reflection)](https://www.npmjs.com/package/grpc-server-reflection)\n[![](https://flat.badgen.net/github/license/ackeecz/grpc-server-reflection)](https://github.com/ackeecz/grpc-server-reflection/blob/master/LICENSE)\n\n## Usage\n\nThe package adds a defined reflection service implementation to your server. The data about your schema is read from a descriptor set, which you can produce with your code generator.\n\n### Generate descriptor set\nGenerate descriptor set with `grpc_tools_node_protoc` using `descriptor_set_out` and `include_imports`, e.g.:\n```\ngrpc_tools_node_protoc\n    --descriptor_set_out=path/to/descriptor_set.bin\n    --include_imports\n    ./api/**/*.proto\n```\n\n### Add reflection\n```ts\nimport { Server } from '@grpc/grpc-js';\nimport { addReflection } from 'grpc-server-reflection'\n\nconst server = new Server()\naddReflection(server, 'path/to/descriptor_set.bin')\n```\n\n## Notes\n\n- Reflection can be added before or after registering other services\n- All services from descriptor set are available\n- Server reflection service is not included (unless added manually in the descriptor set)\n- Running tests requires [`grpc_cli`](https://github.com/grpc/grpc/blob/master/doc/command_line_tool.md)\n\n## Thanks\n\nThis project is heavily inspired and ports some parts of code from [`nice-grpc-server-reflection`](https://www.npmjs.com/package/nice-grpc-server-reflection). I respectfully burrowed some of the code based on [encouragement](https://github.com/grpc/grpc-node/issues/79#issuecomment-873360048) from the author, to available solid server reflection for Node.js for general purpose. I tried to implement it myself but failed due to some incompatibilities with binary format in `protobuf-js` with the C++ implementation. Using descriptor sets avoids as in the referenced project avoids the issues.\n\n## See also\n\nHere is a list and comparison with the similar projects:\n\n| package                                                                                    | full support | `@grpc/grpc-js` support | `grpc` support | framework agnostic | service detection |\n| ------------------------------------------------------------------------------------------ | ------------ | ----------------------- | -------------- | ------------------ | ----------------- |\n| [`grpc-server-reflection`](https://www.npmjs.com/package/grpc-server-reflection)           | ✅️           | ✅️                      | ✅️             | ✅️                 | ✅️                |\n| [`nice-grpc-server-reflection`](https://www.npmjs.com/package/nice-grpc-server-reflection) | ✅️           | ✅️                      | ❌             | ❌                 | ❌                |\n| [`grpc-node-server-reflection`](https://www.npmjs.com/package/grpc-node-server-reflection) | ❌           | ✅️                      | ❌             | ❌                 | ❌                |\n| [`grpc-reflection-js`](https://www.npmjs.com/package/grpc-reflection-js)                   | ❌           | ✅️                      | ❌             | ❌                 | ❌                |\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fackeecz%2Fgrpc-server-reflection","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fackeecz%2Fgrpc-server-reflection","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fackeecz%2Fgrpc-server-reflection/lists"}