grpc-swagger 使用手册

柔情只为你懂 2023-07-19 12:03 2阅读 0赞

### 文章目录 ###

*   *  grpc-swagger是干啥的？
     *  怎么用？

## grpc-swagger是干啥的？ ##

是一个通过反射机制， 无侵入的可以让你在本地通过http方式请求你的grpc方法，简单来说是个grpc本地调试工具。

## 怎么用？ ##

1.  从github上下载源代码，然后编译  
    目的是获取 grpc-swagger-web项目target目录下的可执行jar包：grpc-swagger.jar (也可能是带版本号grpc-swagger.0.0.1-snapshot.jar)
2.  把1这个包跑起来  
    java -jar grpc-swagger.jar –server.port=8888  
    默认是8080端口，如果需要修改端口 加–server.port=xxxx;
3.  启动你的grpc服务
4.  注册你的grpc服务到grpc-swagger  
    注册方法：  
    通过postman，请求 127.0.0.1:8080/register, POST方式 ，body使用form-data  
    参数是host 和 port，host 填你本地的IP地址127.0.0.1 ,port填grpc服务的端口  
    注册成功会返回服务列表  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpdGNheA_size_16_color_FFFFFF_t_70]
5.  查看已注册的服务-- \[可跳过\]  
    查看方式：post请求 127.0.0.1:8080/listServices 即可，不用传参数
6.  查看服务下的接口详情–\[可跳过\]  
    查看方式：post请求 127.0.0.1:8080/v2/api-docs ，参数(form-data格式)  
    service ，值填写grpc服务的 包名.服务名  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpdGNheA_size_16_color_FFFFFF_t_70 1]
7.  通过http的方式调用你的grpc服务  
    请求方式：  
    post请求地址：127.0.0.1:8080/package.ServiceName.MethodName  
    请求参数：json格式的参数，内容你的服务定义的参数  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpdGNheA_size_16_color_FFFFFF_t_70 2]  
    调用正常的话，就会返回了。请求到了你的服务，可以debug调试。

–结束–

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpdGNheA_size_16_color_FFFFFF_t_70]: /images/20230528/c2bc9c9610414aeabe8be88ad2f148c0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpdGNheA_size_16_color_FFFFFF_t_70 1]: /images/20230528/0fc63a4bbd1b4f9eb56bb010ac8b0fcd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FpdGNheA_size_16_color_FFFFFF_t_70 2]: /images/20230528/c2164add105040ee9be84e8535d4e89d.png