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

有没有从 json 生成接口文档的工具

  •  
  •   pheyer · 2015-04-03 10:19:52 +08:00 · 10090 次点击
    这是一个创建于 3526 天前的主题,其中的信息可能已经有所发展或是发生改变。
    小公司伤不起啊,各种接口都是靠QQ传达的,还只有request请求,返回的json要靠自己抓包看。突然想到能不能这样做:给定一个request请求和返回的json,就能生成接口文档呢?
    19 条回复    2015-04-05 17:02:16 +08:00
    hging
        1
    hging  
       2015-04-03 10:23:56 +08:00
    同求.
    phoenixlzx
        2
    phoenixlzx  
       2015-04-03 10:24:50 +08:00 via Android
    这个。。。自己写也不难吧
    hcymk2
        3
    hcymk2  
       2015-04-03 10:30:44 +08:00
    swagger
    janxin
        4
    janxin  
       2015-04-03 10:32:26 +08:00
    如果完全自动化应该不太可能吧,怎么知道你的每个参数和返回是啥意思....

    不过我觉得swagger应该能满足你们的需求,可以从一个json生成文档和测试用例。不过json有格式要求。 http://swagger.io

    有在线编辑器直接写文档,yaml格式。 http://editor.swagger.io,可以到处成json,也可以直接生成对应的client代码
    virusdefender
        5
    virusdefender  
       2015-04-03 11:13:57 +08:00
    以前写过,后端自动去请求
    simman
        6
    simman  
       2015-04-03 11:14:13 +08:00
    http://apidocjs.com ,你值得拥有~~~
    simman
        7
    simman  
       2015-04-03 11:15:01 +08:00
    不好意思,昨晚加班眼睛不好用,没看清是 json
    laotan88
        8
    laotan88  
       2015-04-03 13:13:54 +08:00
    团队在用,推广下
    http://thx.github.io/RAP/
    mornlight
        9
    mornlight  
       2015-04-03 13:36:53 +08:00
    8楼说的RAP 可以,阿里开源的,我也在用
    pheyer
        10
    pheyer  
    OP
       2015-04-03 14:26:32 +08:00
    @janxin 网站打开很慢很慢
    pheyer
        11
    pheyer  
    OP
       2015-04-03 14:57:56 +08:00
    @laotan88 不知道怎么跑起来,不会java,eclipse中运行总是出错……
    mornlight
        12
    mornlight  
       2015-04-03 15:04:15 +08:00
    @pheyer 不不不,你不需要编译运行,你只需要下载release 分支里的war包
    https://github.com/thx/RAP/tree/release/release
    hujianxincom
        13
    hujianxincom  
       2015-04-03 17:05:03 +08:00
    有为个 iodoc的东西,可以按照 JSON 生成指定 的APIDEMO
    xmbaozi
        14
    xmbaozi  
       2015-04-03 17:14:33 +08:00
    我写过php。把常用的自动写个映射,没用到的再人工补充,很快
    pheyer
        15
    pheyer  
    OP
       2015-04-03 22:39:57 +08:00
    @mornlight 果然,好吧,白白浪费了那么多的时间
    juxingzhutou
        16
    juxingzhutou  
       2015-04-04 10:09:42 +08:00
    天天去跟负责接口的同事吵,我的接口列表就是这么来的。
    yafeilee
        17
    yafeilee  
       2015-04-04 12:33:39 +08:00
    @pheyer 虽说这里是 php 节点, 我还是推荐下Rails 下的 lina: https://linarb.org

    可以根据 API 约束自动生成 APIDOC. PHP 界也许也可以弄一个出来.
    yafeilee
        18
    yafeilee  
       2015-04-04 12:34:25 +08:00
    @pheyer 地址多了一个 s, http://linarb.org/
    pheyer
        19
    pheyer  
    OP
       2015-04-05 17:02:16 +08:00
    @yafeilee 这个不能从JSON导入生成APIDOC吧?我是做iOS开发的这接口文档本来应该是别人给我的
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3521 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 10:56 · PVG 18:56 · LAX 02:56 · JFK 05:56
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.