让文档参与到你的开发中，帮助你提高效率 - XJZProxy

主要功能：

HTTP/HTTPS/HTTP2/GRPC 请求代理
按 host, connection 分组请求历史
简单的搜索语言过滤请求历史
自动生成接口文档预览
自动生成响应数据
自动对比请求、响应数据，并显示差异
按过滤结果生成相应的错误统计

通常我们合作开发时都是：

商量接口文档 => 使用者自己生成假数据开撸 =>   最对接真实接口，发现不对再改
          \\=> 开发接口                                 //

甚至是

商量接口文档 => 开发接口 => 等接口好 => 发现不对再改接口或文档

最后基本都是接口使用者拿到文档时没有真实接口可以用。真实接口好了后，改着改着真实接口和文档完全不一样了。

此工具就是为了提高这一过程的效率。一个最简单的示例

先在创建项目并写个文档(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"}

当然，在工具中查看渲染好的漂亮文档也是不能少的。更多文档格式请参考这里

有兴趣的朋友可以在这里下载（目前只支持 Mac 与 Ubuntu，其它 linux 系统的包看情况再折腾了)，然后发邮件到 base64 eGllamlhbmd6aGlAZ21haWwuY29t。我会给前 100 名发放永久证书哟。记得带上标题 "XJZProxy 证书申请"，不然我可能注意不到。当然，没有证书的话，也可以享受完整的代理功能及受限的文档代理功能。

xjz19901211

2019-05-30 09:46:27 +08:00

@marsgt 工具的定位是提高协作开发效率。目前已经完成的功能，大部分都是相当于一个本地的 mock 服务。

我们的目标是以 `api 文档` 为联结点来解决前后端协作问题。简单来说就是前后端使用这个工具来辅助开发，大家只要都满足了文档了定义（工具自动基于文档定义去检查），那么所有工作完成后，真实的对接也是没有问题的。

对前端来说，有了这份文档就可以直接开始调用接口、调试了。
对后端来说，通过这份文档，也可以验证真实的 api 接口是否与约定的一致。不过，后端方面的功能还在开发中。目前只能在配合前端调用来检查真实接口是否符合定义，而无法单独使用。