V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
jimiton
V2EX  ›  分享创造

分享我们开发的工具 Conch,可以减少 API 开发维护至少 20%工作量

  •  1
     
  •   jimiton · 2018-07-12 23:34:46 +08:00 · 4578 次点击
    这是一个创建于 2324 天前的主题,其中的信息可能已经有所发展或是发生改变。
    我们开发中常用 postman 来跟进 API,可是有一些需求总是满足不了,比如
    1,精确定位到某一个环境参数或者字段的错误
    2,反应 API 迭代后的数据变化
    3,团队评论、跟进功能
    4,如果一个产品已经上线运维了,希望 APP 这边出现一些简单问题的时候(数据来自 API),可以快速定位问题
    5,多平台互动,给不同角色提供不同的便利工具

    基于这些,我们开发了 Conch,Conch 有三个平台
    1,Chrome 插件版。可以提供给团队中的开发者使用,也可以给个人开发者使用。可以给自己的项目中所有的 API 设置复杂的 check point,并定时生成报表
    2,Web 版本,可以管理角色和查看报表
    3,微信小程序版本,查看最新的允许日志和报表

    大家有兴趣的话可以试用,这个项目我们团队已经用了一段时间,节省了大量的人力,提高了至少 20%的开发效率,尤其是减少了 bug 定位的时间,对于 PM 和项目经验把控项目有非常大的帮助。

    Chrome 插件版地址: https://chrome.google.com/webstore/detail/conch-api/eaajlbocgagngoaleogcmojhaolpeopb?hl=zh-CN
    项目及成员管理后台地址: https://www.starcloudtec.com/conch-console/
    小程序:微信小程序内搜索 ConchAPI,有测试用户的数据可以体验一下

    如果大家有任何的问题或者建议欢迎联系我,谢谢
    第 1 条附言  ·  2018-07-13 00:24:08 +08:00
    补充一下图片说明

    图片 1,Chrome 版本主页,我添加了两个项目以及几个 API
    http://imglf5.nosdn0.126.net/img/OER1UjJZbXROdkVlNWFkVk1ZUWVSNUFOQ2paQThYM0F5WkZwYzlnUnREUnZSTFJQRXlDRHF3PT0.jpg


    图片 2,API 详情页,编辑 check point 的时候,可以看到针对单个参数做各种设置
    http://imglf3.nosdn0.126.net/img/OER1UjJZbXROdkdWWC92SVN0SzBxQVd4NnVqZFNRd1N6SWdBUHRtSWlkbjJjcENNQ3MyMzF3PT0.jpg

    图片 3,Web 页首页
    http://imglf5.nosdn0.126.net/img/OER1UjJZbXROdkVaTGk1K2thQmpsMDdyY2V0R3Eyd1EvM1R0b3JSZjdEdnQ3WlR5N01JQWNnPT0.jpg

    图片 4,小程序页首页,查看最新的 record 情况,可以看到有哪些 record 有问题
    http://imglf6.nosdn0.126.net/img/OER1UjJZbXROdkhKSktpSVd6UlJqa1gxVTkrK1gya2pYT1QwZjY2RVpUMVRUR0hPWkxhZURRPT0.jpg

    图片 5,小程序,单个项目的图标页,可以按照日期查看该项目在选择日期范围内的稳定性情况

    http://imglf5.nosdn0.126.net/img/OER1UjJZbXROdkhNOUU5YmhPZnM4UTlad1V5dGpNZFAycE5EQ3oyVXgwbGtQc24zZXowanVnPT0.jpg
    第 2 条附言  ·  2018-07-13 00:27:06 +08:00
    额,图片 url 单独在浏览器可以访问,放在这里不能访问了。大家有兴趣的可以看一下 我的 lofter 地址 http://pppsy.lofter.com/post/ac5d3_eeba1f81
    第 3 条附言  ·  2018-07-14 00:30:59 +08:00
    谢谢大家的使用,Conch 还在快速迭代中,如果有兴趣的话欢迎参加我们的内测 QQ 群,822530401
    第 4 条附言  ·  2018-07-14 09:42:23 +08:00
    更新---0714
    chrome 版本更新
    1,底部 record 面板实现可以上下隐藏
    2,record 实现实时上传,可以在小程序、web 端实时看到新的 record 了
    3,record 上传的原始数据 body 做了截断至 1k(解决部分原始数据太大导致数据库写入失败的问题)
    4,针对反馈的 check point 不会用的问题,check point 部分加了功能说明
    5,server 做了数据优化,提供了数据处理的效率

    web 端
    1,修改了 record 上传 API
    2,去掉了 API chart 表

    小程序端
    1,精简了提示
    2,去掉了 API chart
    20 条回复    2018-09-07 19:01:19 +08:00
    jimiton
        1
    jimiton  
    OP
       2018-07-12 23:52:15 +08:00
    我有办法补充图么
    chinvo
        2
    chinvo  
       2018-07-12 23:53:25 +08:00
    @jimiton #1 Append 可以放图
    jimiton
        3
    jimiton  
    OP
       2018-07-12 23:56:42 +08:00
    @chinvo 没有看到 append 功能,我刚点击发布的时候好像看到了 append 和 edit,过了几分钟就没有了
    torbrowserbridge
        4
    torbrowserbridge  
       2018-07-12 23:57:19 +08:00
    读取和更改您在访问的网站上的所有数据

    ---为什么需要这么大的权限呢?
    jimiton
        5
    jimiton  
    OP
       2018-07-13 00:01:54 +08:00
    @torbrowserbridge 你这个问题是我们的 Chrome 插件的权限么?具体这个权限我可以明早查一下,不过有三个地方可能会跟这个相关
    1,用 local storage 做了用户登录状态缓存 和 一些不属于数据库结构的状态缓存
    2,用 sqlite 做了 project、API、record 表的存储
    3,这个可能是原因,因为 API 是用户自定义的,需要做跨域访问。
    我不清楚是不是以上三个原因导致的申请这个权限,如果以上三个不需要这个权限,明天我会重发一版,去掉这个权限。谢谢你的反馈
    34C
        6
    34C  
       2018-07-13 05:26:55 +08:00 via iPhone
    @torbrowserbridge 因为不确定你会在哪个网站做调试吧
    wzw
        7
    wzw  
       2018-07-13 07:59:59 +08:00 via iPhone
    可以理解成替代 postman 的工具吗?
    torbrowserbridge
        8
    torbrowserbridge  
       2018-07-13 09:05:52 +08:00
    @34C 应该是这样
    jimiton
        9
    jimiton  
    OP
       2018-07-13 10:27:18 +08:00
    @wzw 我们和 postman 有两点不同
    1,postman 主要『面向开发者』,Conch 会『面向团队所有角色』,开发者可以测试 API 和周知 API 变化(doc 功能在开发中),所有角色(PM、RD)都可以看报表(报表功能现在只能看昨天的,下一版本会迭代成实时的)
    2,postman 主要是『面向开发阶段』,Conch 在开发阶段的支持上会追赶 postman,『同时支持运维阶段』。这个是这个产品出现的核心原因,之前我们公司刚创立的时候接了一些外包,需要定时维护,但是出现问题之后定位需要很久,有了这个,基本 90%以上的问题可以秒定位,并且可以在客户发现之前我们就已经发现并处理好了。Conch 的 check point 的概念类似于 test case,但是操作上直接面向了非编程人员,团队其他角色也可以用。用户可以根据自己的需求灵活自定义提醒事件。
    jimiton
        10
    jimiton  
    OP
       2018-07-13 10:45:04 +08:00
    @torbrowserbridge 早上查了,权限这块,不能降级了。
    我们权限的设置是
    permissions": [
    "storage", //local storage
    "http://*/*", //允许跨域请求
    "https://*/*" //允许跨域请求
    ]
    这三个都是功能需求,跨域请求是为了让用户自己的 API 可以正常 run,除此之外,插件并不会做任何收集或检测用户其他浏览情况
    klmun
        11
    klmun  
       2018-07-13 10:57:57 +08:00
    @jimiton 反馈一个问题,我用我自己的 gmail 邮箱注册时提示邮箱不正确。大概率是因为邮箱名带英文半角.
    klmun
        12
    klmun  
       2018-07-13 10:58:47 +08:00
    jimiton
        13
    jimiton  
    OP
       2018-07-13 10:58:50 +08:00
    @klmun 收到,我这边检测下,谢谢
    torbrowserbridge
        14
    torbrowserbridge  
       2018-07-13 11:04:54 +08:00
    @jimiton 好的谢谢
    mikuazusa
        15
    mikuazusa  
       2018-07-13 11:08:02 +08:00
    不开源不敢用...
    jimiton
        16
    jimiton  
    OP
       2018-07-13 13:05:44 +08:00
    @mikuazusa 你可以试用下 Mac 的单机版,预计本周末提交审核,不出意外下周就可以看到了
    jimiton
        17
    jimiton  
    OP
       2018-07-14 09:43:58 +08:00
    新的版本发布了,主要是解决了数据实时上传的问题,小程序可以实时看到报告了,使用的大家麻烦升级一下哈,下一版本我们会加入新版本提示的功能
    zyc14980
        18
    zyc14980  
       2018-07-15 19:34:19 +08:00
    路过 先支持一下
    spice630
        19
    spice630  
       2018-07-19 14:27:50 +08:00
    一个工具可以秒定位问题? 这么神奇的嘛?
    jimiton
        20
    jimiton  
    OP
       2018-09-07 19:01:19 +08:00
    chrome、小程序发布 v1.1.0 版本
    1,体验优化
    2,加入 demo 案例,用户刚注册进来可以体验项目的功能
    Mac 版本 v1.0 发布,单机版本,审核中
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3346 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 04:47 · PVG 12:47 · LAX 20:47 · JFK 23:47
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.