代码拉取完成,页面将自动刷新
同步操作将从 grpc-swagger/grpc-swagger 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
gRPC-swagger 是基于 gRPC 反射开发的一款 gRPC 调试工具,可以使用 swagger-ui 方便地展示和调用 gRPC 方法。因为 gRPC-swagger 是基于反射开发,所以使用时无需修改 proto 及相关的代码实现,只需在启动服务时开启反射功能。
wget https://github.com/grpc-swagger/grpc-swagger/releases/download/0.1.1/grpc-swagger-web-0.0.1-SNAPSHOT.jar
java -jar grpc-swagger-web-0.0.1-SNAPSHOT.jar
git clone https://github.com/grpc-swagger/grpc-swagger
cd grpc-swagger
mvn clean package
java -jar grpc-swagger-web/target/grpc-swagger-web-0.0.1-SNAPSHOT.jar
默认使用8080端口,如果使用其他端口可以通过--server.port=端口号
的方式设置
java -jar grpc-swagger-web/target/grpc-swagger-web-0.0.1-SNAPSHOT.jar --server.port=8888
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-services</artifactId>
<version>${grpc.version}</version>
</dependency>
Server server = ServerBuilder.forPort(SERVER_PORT)
.addService(new HelloServiceImpl())
.addService(ProtoReflectionService.newInstance())
.build()
.start();
<host:port>/v2/api?service=<fullServiceName>
,其中fullServiceName
就是上面返回注册成功的服务。Try it out
进行服务测试url:/register
参数:
host
- 地址(必填)port
- 端口(必填)groupName
- 分组名(选填),默认是 host:port
,通过指定分组名可以将部署相同服务的实例归为一组返回示例
{
"code": 0,
"data": {
"groupName": "localhost:12347",
"services": [
"io.grpc.grpcswagger.showcase.HelloService"
],
"endpoints": [
"localhost:12347"
],
"success": true
}
}
url: /listServices
返回示例
{
"code": 0,
"data": {
"localhost:12347": {
"groupName": "localhost:12347",
"services": [
"io.grpc.grpcswagger.showcase.HelloService"
],
"endpoints": [
"localhost:12347"
],
"success": true
}
}
}
url: /{rawFullMethodName}
参数:
rawFullMethodName
- 需要调用方法的完整名,例如 io.grpc.grpcswagger.showcase.HelloService.GetUser
payload
- gRPC 方法参数,JSON 格式。可以使用 endpoint
参数,来指定需要调用的实例。返回结果就是方法执行结果。
url: /v2/api-docs
返回 swagger-ui 展示需要的数据。
参数:
感谢 polyglot 项目,本项目中 gRPC 反射相关逻辑基于该项目进行修改。
Feel free to open an issue or pull request. We will appreciate it!
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。