V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
zybdfdz
V2EX  ›  程序员

API 开发者福利--API 在线管理,模拟请求测试,生成文档工具之 Apizza

  •  
  •   zybdfdz · 2016-10-21 13:58:12 +08:00 · 5395 次点击
    这是一个创建于 2737 天前的主题,其中的信息可能已经有所发展或是发生改变。

    Apizza 是国内领先的在线 API saas 管理平台,支持在线的 API 调试,接口管理,快速生成文档,项目管理以及分享。

    Apizza ( http://apizza.cc?f=v2ex) 平台分为开发模式和浏览模板,开发模式只有用户自己可以打开,浏览模式是供其他人查看,测试使用。

    平台支持标准的 http 协议请求,支持添加 header ,支持标准 json,xml,html,text 四种返回格式, 自动格式化展示。平台做了许多体验优化,比如参数列表和 url 自动转换, 请求文档字段一键生成。响应文档的字段可以从 api 返回自动生成。请求自动存为历史记录, 支持定义的环境变量,可以方便切换线下,下上环境,文档导出等等。

    下面就简单介绍下怎么使用 Apizza 进行接口测试。

    第一步:准备接口

    <?php
       namespace Home\Controller;
       use Think\Controller;
       class ApiController extends Controller {
         public function index(){
           $result = array(
                 'status'=>1,
                 'data'=>array(
                   'name'=>'My name',
                   'tel'=>'12345678',
                 )
             );
           header("Content-Type: application/json");
          echo json_encode($result);
       }
    }
    

    第二步:测试接口

    登陆 Apizza ,创建一个新项目,进入控制台,填写接口地址,并点击发送,效果如图

    可以看出,效果不错!

    接下来测试一下传递参数的情况

    <?php
    namespace Home\Controller;
    use Think\Controller;
    class ApiController extends Controller {
        public function index(){
        $requests = I();
        $result = array(
            'status'=>1,
            'data'=>$requests
        );
        header("Content-Type: application/json");
        echo json_encode($result);
        }
    }
    

    测试效果图如下

    测试效果和展示效果都还不错,而且直观,简洁。

    第三步:写文档

    Apizza 可以方便的写文档,只要一个按钮就可以把模拟的字段自动生成文档字段。 这个功能还是很方便的。

    点击那个 U 的按钮,可以自动生成红色框里面的字段,你只要把说明补充上就行了。最后点击保存。

    第四步:导出文档

    这个功能不错,导出的文档格式也很漂亮。如下图

    好了,基本介绍了 Apizza 的使用流程,他还有许多其他的功能,这里没有做介绍,可以自己 去体会一下,最后补充一下,要使用 apizza ,需要按照他的 chrome 插件,这个主要是做跨域的, 不然不能使用哦^_^

    22 条回复    2016-12-03 19:28:48 +08:00
    tmackan
        1
    tmackan  
       2016-10-21 14:09:09 +08:00
    整个风格,抄的 postman= =
    tmackan
        2
    tmackan  
       2016-10-21 14:09:39 +08:00
    基本一毛一样啊
    Immortal
        3
    Immortal  
       2016-10-21 14:15:02 +08:00
    风格同意楼上
    之前我自己也想搭建一个项目,不过后来流产了
    因为为了一些接口私密性 更多人愿意自己搭建内部的类似平台 而不是放到你们的平台上
    zybdfdz
        4
    zybdfdz  
    OP
       2016-10-21 14:23:41 +08:00
    @tmackan 我们只是觉得 postman 的体验比较好,也没有抄袭他原始代码啊。而且也是减少学习成本,要是在整一套新的逻辑,意义又有 多大。我们也是尽量优化他不好的地方, postman 确实很好。我也同意^_^
    zybdfdz
        5
    zybdfdz  
    OP
       2016-10-21 14:26:03 +08:00
    还有一点,你有什么需求给我们提,我们可以加上和修改, postman 中不行了嘛,是不(嘿嘿)
    Kokororin
        6
    Kokororin  
       2016-10-21 14:29:38 +08:00
    ThinkPHP+XAMPP
    zachlhb
        7
    zachlhb  
       2016-10-21 14:30:00 +08:00
    还是习惯用 insomnia
    az999
        8
    az999  
       2016-10-21 14:32:26 +08:00
    我用着感觉没啥特别的。。
    mablinuxp
        9
    mablinuxp  
       2016-10-21 15:10:10 +08:00
    导出文档不错。
    cenxun
        10
    cenxun  
       2016-10-21 15:25:33 +08:00
    赞一个
    JulyXing
        11
    JulyXing  
       2016-10-21 15:44:21 +08:00
    最近准备考虑用 swagger 生成 API 文档
    xshwy
        12
    xshwy  
       2016-10-21 15:49:08 +08:00 via iPhone
    支持一下
    millson
        13
    millson  
       2016-10-21 15:51:47 +08:00
    有 mock server 功能吗
    zybdfdz
        14
    zybdfdz  
    OP
       2016-10-21 15:59:16 +08:00
    @millson 目前还没有,这块我们有考虑^_^
    HowToMakeLove
        15
    HowToMakeLove  
       2016-10-21 16:40:05 +08:00
    我们用 apidoc
    HowToMakeLove
        16
    HowToMakeLove  
       2016-10-21 16:41:14 +08:00
    而且感觉这个东西没有解决什么痛点。
    Charkey
        17
    Charkey  
       2016-10-21 16:47:50 +08:00
    @JulyXing 问一下啊,我现在也用 swagger ,不过是在 swagger-ui.html 页面使用,你是自己写个程序生成 api 文档吗?还是 swagger 就支持这个?谢谢
    zooandzoo
        18
    zooandzoo  
       2016-10-21 17:56:24 +08:00
    mark
    loveyu
        19
    loveyu  
       2016-10-21 18:50:06 +08:00 via Android
    写个脚本读取 php doc ,我现在就这样干的
    sxul07
        20
    sxul07  
       2016-11-29 22:38:59 +08:00
    =。=啊 不能自己用代码处理返回或者发送的内容么
    zybdfdz
        21
    zybdfdz  
    OP
       2016-12-01 10:40:04 +08:00
    @sxul07 自己处理?你是说自己写脚本处理?
    sxul07
        22
    sxul07  
       2016-12-03 19:28:48 +08:00
    @zybdfdz 类似吧 手上有几个 API 的数据是 HTTPS 发送之前把 body 区域的 json 用自定义算法加密发出去,收回来的数据也要先解密出来 json 才行 用这种 API 工具好像就不行了
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   949 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 22:28 · PVG 06:28 · LAX 15:28 · JFK 18:28
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.