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

好用的接口测试、接口文档的工具

  •  2
     
  •   balabalaguguji · 2022-02-18 09:13:42 +08:00 · 4864 次点击
    这是一个创建于 1028 天前的主题,其中的信息可能已经有所发展或是发生改变。

    这是我创业过程中做的一个附属项目

    因为开发中总是要编写接口文档,有时候文档要对外,必须写得专业点,体现我们得专业性,最好是能直接文档+测试一起,并且加上调用示例,这样别人一看就能明白怎么调用

    网上找过很多都没满意的,后面索性自己开发了一套出来,目标就是要轻松编写出专业漂亮的文档,就叫 EasyDoc ,中文名易文档

    易文档 = 文档编写 + 接口测试 + Mock + 测试用例

    废话不多少,直接看效果:K8S 教程 | 接口文档示例

    可以非常灵活的制作文档,比如自定义参数块、自定义字段、自定义描述块,还可以把多个文档项目集合到一起变成一个文档网站,并且可以绑定自定义域名。

    最近还增加了一个所见即所得的 Markdown 编辑器,类似 Typora 的效果,编写体验上更加友好,欢迎体验。

    易文档

    18 条回复    2022-02-23 10:50:41 +08:00
    yisier
        1
    yisier  
       2022-02-18 09:47:01 +08:00
    op 这么高产?
    balabalaguguji
        2
    balabalaguguji  
    OP
       2022-02-18 16:26:44 +08:00
    @yisier #1 招人一起做出来的,一个人搞不定那么多事。
    StephenZzz
        3
    StephenZzz  
       2022-02-18 23:09:19 +08:00
    B 站视频已赞
    balabalaguguji
        4
    balabalaguguji  
    OP
       2022-02-19 09:56:40 +08:00
    @StephenZzz #3 感谢
    LeslieLeung
        5
    LeslieLeung  
       2022-02-21 08:14:57 +08:00 via iPhone
    后续有可能支持私有部署吗?
    balabalaguguji
        6
    balabalaguguji  
    OP
       2022-02-21 09:09:04 +08:00
    @LeslieLeung #5 已经支持的呀,联系客服就可以了
    hanxiV2EX
        7
    hanxiV2EX  
       2022-02-21 10:48:57 +08:00
    不知道发现页面里的文档是作者自愿分享的还是。。。有些带域名的接口分享出来可能会有安全隐患吧,比如这个:

    https://easydoc.net/doc/58089581/ONd4K7DU/JA0ogXqL

    对着 api 来写爬虫是不是简单多了
    hanxiV2EX
        8
    hanxiV2EX  
       2022-02-21 10:57:49 +08:00
    https://easydoc.net/doc/49983434/VNyJ7lKs/psqWozPz

    比如这个写着私人文档,估计这个作者以为别人看不到的吧。。。
    balabalaguguji
        9
    balabalaguguji  
    OP
       2022-02-21 13:59:43 +08:00
    @hanxiV2EX #7 发现页的都是自己公开的,可以选择公开还是私有的。
    yestodayHadRain
        10
    yestodayHadRain  
       2022-02-21 22:23:19 +08:00 via iPhone
    哈哈哈,好熟悉的页面,看过楼主的 B 站视频
    russ44
        11
    russ44  
       2022-02-22 12:00:25 +08:00
    Github 登录完这样是正常的吗

    balabalaguguji
        12
    balabalaguguji  
    OP
       2022-02-22 12:22:39 +08:00
    @russ44 #11 不太正常,我们看看
    balabalaguguji
        13
    balabalaguguji  
    OP
       2022-02-22 12:24:06 +08:00
    @russ44 #11 没重现到,不知道你怎么出现的
    russ44
        14
    russ44  
       2022-02-22 12:28:05 +08:00
    @balabalaguguji #13 下载安装, GitHub 登录, 就出现了. 重启后重新 Github 登录变正常
    balabalaguguji
        15
    balabalaguguji  
    OP
       2022-02-22 15:41:21 +08:00
    @russ44 #14 好的,感谢反馈
    ideacco
        16
    ideacco  
       2022-02-22 19:24:45 +08:00
    有开源计划么?
    balabalaguguji
        17
    balabalaguguji  
    OP
       2022-02-22 21:20:00 +08:00
    @ideacco #16 没有呢
    mingsz
        18
    mingsz  
       2022-02-23 10:50:41 +08:00
    期待 mac 版本
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1353 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 21ms · UTC 17:16 · PVG 01:16 · LAX 09:16 · JFK 12:16
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.