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

Tornado 如何自动生成 Rest API 文档

  •  
  •   zjmdp · 2015-01-20 16:37:17 +08:00 · 7220 次点击
    这是一个创建于 2761 天前的主题,其中的信息可能已经有所发展或是发生改变。
    有个设想就是通过注释或者注解描述Rest API,通过工具自动生成API描述文档,每次git commit后自动update文档,使得文档始终保持最新,减少后台和终端之间的沟通成本,不知道Tornado下是否有类似的解决方案?大概google了一把没看到靠谱的方案
    12 条回复    2016-06-08 13:37:22 +08:00
    loading
        1
    loading  
       2015-01-20 16:50:45 +08:00 via Android
    这是python的事,修改下搜索关键字!
    zjmdp
        2
    zjmdp  
    OP
       2015-01-20 17:09:31 +08:00
    @loading 哈哈,也属于程序员的事呀
    haoba
        3
    haoba  
       2015-01-20 17:14:54 +08:00
    @zjmdp 这位先生说的莫不是Sphnix ?
    haoba
        4
    haoba  
       2015-01-20 17:21:17 +08:00   ❤️ 1
    swagger 好像更好一些。
    otmb
        5
    otmb  
       2015-01-20 17:34:00 +08:00
    听说ror完爆tonardo,真是这样么?
    binux
        6
    binux  
       2015-01-20 18:39:33 +08:00
    这有什么难的,自己写一个呗

    zjmdp
        7
    zjmdp  
    OP
       2015-01-20 18:40:06 +08:00
    @otmb 我也喜欢ruby,担心ruby程序员不太好找
    Fikhtengol
        8
    Fikhtengol  
       2015-01-20 19:00:01 +08:00
    torrnado性能完爆ror 会告诉你吗
    zjmdp
        9
    zjmdp  
    OP
       2015-01-20 19:04:32 +08:00
    @haoba 嗯,这个方案看上去可以,是个通用方案,先研究下
    otmb
        10
    otmb  
       2015-01-21 02:08:52 +08:00
    @zjmdp python程序员好找么?
    joshyu8
        11
    joshyu8  
       2016-05-31 14:38:01 +08:00
    @binux , 你的工具看起来很不错,有开源吗?
    Wichna
        12
    Wichna  
       2016-06-08 13:37:22 +08:00
    比较好的方式是 Swagger
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   2409 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 25ms · UTC 12:27 · PVG 20:27 · LAX 05:27 · JFK 08:27
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.