首先,我承认我有错,没有认真读发帖指南,就直接在技术区发了一贴。然后发现了这个区。
回到正题,官网 https://xjzproxy.xjz.pw/zh-cn/
主要功能:
商量接口文档 => 使用者自己生成假数据开撸 => 最对接真实接口,发现不对再改
\\=> 开发接口 __/
甚至是
商量接口文档 => 开发接口 => 使用者等接口好 => 发现不对再改接口或文档
最后基本都是接口使用者拿到文档时没有真实接口可以用。真实接口好了后,改着改着真实接口和文档完全不一样了。 或者本来规定的参数,上级后才发现没有提交。
此工具就是为了提高这一过程的效率。让文档告诉你接口请求的参数、服务器返回的数据是否与文档中的定义一致。 拿到文档不用等接口开发好就有可以调用。
一个最简单的示例, 先在创建项目并写个文档(YAML 格式)
project:
host: mydomain.com
apis:
- title: Get a user
method: GET
path: /api/v1/users/\d+
response:
success:
http_code: 200
data:
id: 1
name: .t/name
然后就可以通过 XJZProxy 代理来访问了
$ curl http://mydomain.com/api/v1/users/123 --proxy localhost:9898
{"id": 1, "name": "random name"}
当然,你可以在移动设备、浏览器中通过代理地址访问接口。更多文档书写帮助请参考这里
请求参数和文档对不上时,会有提示
如果你在使用 GRPC 的话,只要配置好 protobufs 的路径,就可以直接调用接口了。当然,如果你想定义 GRPC 接口返回的数据内容,还是需要在文档中定义好一些数据模板。
在工具中查看渲染好的漂亮文档也是不能少的。
有兴趣的朋友可以在这里下载试用(目前只支持 Mac 与 Ubuntu,其它系统以后看情况再折腾了)。
发邮件到 base64 eGllamlhbmd6aGlAZ21haWwuY29t
。我会给前 100 名发放永久证书哟(刚上线求试用,暂时没有开通购买渠道)。记得带上标题 "XJZProxy 证书申请",不然我可能注意不到。当然,没有证书的话,也可以享受完整的代理功能及受限的文档代理功能。