文档即接口 - XJZProxy 新版本发布 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
xjz19901211
V2EX    分享创造

文档即接口 - XJZProxy 新版本发布

  •  
  •   xjz19901211
    xiejiangzhi 2019-06-10 16:28:27 +08:00 2363 次点击
    这是一个创建于 2370 天前的主题,其中的信息可能已经有所发展或是发生改变。

    官网 https://xjzproxy.xjz.pw

    简单的介绍可以看老帖子 t/571213

    新版本加入了一个很方便定义数据类型的方便:正则表达式

    比如想要定义中文名类型,只需要写一个中文匹配的正则

    project: host: mydomain.com types: chinese_name: regexp: "^[\u4e00-\u9fa5]{2,4}$" apis: - title: get a user method: get path: /users/\d+ response: success: data: id: 1 name: .t/chinese_name 

    保存后,几秒后就可以通过工具的代理服务访问 mock api 了。

    $ curl http://mydomain.com/users/1 --proxy localhost:9898 # {"id":1,"name":""} 

    工具将自动生成能匹配相当正则的字符。


    有人问这个与 swagger + openapi 有什么区别。简单来说,就是本工具是以自身为联结点来提升开发效率为目标的。

    所以本工具主要功能之一 api mock 是以快速轻量为主,接口开发者可以以更简单方便的格式来定义文档。yaml 文件保存后几秒内接口就会自动更新,然后你马上就可以调用 mock 接口了。

    而其它的像快速在不同 mock 数据间切换、对比接口使用者的调用参数是否与文档一致、对比服务器返回数据是否与文档一致等功能,都是为了以提升效率为目标的。

    欢迎大家试用,当然建议、意见、看法、吐槽都欢迎提出,我会努力改进。

    2 条回复    2019-06-11 15:51:24 +08:00
    prasanta
        1
    prasanta  
       2019-06-11 09:27:41 +08:00 via Android
    文档生成接口对纯 CRUD 很友好,但是遇到逻辑问题就会突然变得复杂
    xjz19901211
        2
    xjz19901211  
    OP
       2019-06-11 15:51:24 +08:00 via iPad
    @prasanta 是的,目前可以通过手动切换不同 response 来解决。
    后期我会看看怎么为 response 绑定参数自动切换
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     2792 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 23ms UTC 02:34 PVG 10:34 LAX 18:34 JFK 21:34
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86