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

Swagger 使用情况问卷调查

  •  
  •   hadixlin · 2019-08-01 19:21:15 +08:00 · 5828 次点击
    这是一个创建于 1027 天前的主题,其中的信息可能已经有所发展或是发生改变。

    最近我想做一个扩展 SpringFox 功能的项目,但是不知道有多少人在用 Swagger+SpringFox,故在此发起个问卷调查。

    1. 您使用 Swagger 的项目采用的编程语言是什么?

      A:Java,B:Python,C:Kotlin,D:其他请补充

    2. 使用 Swagger 的方式

      A:SpringMVC 配合 SpringFox,B:直接使用 Swagger 编写 API 文档,C:其他请补充

    3. 其他使用情况请补充

    4. 您期望 SpringFox 扩展的功能是什么

    第 1 条附言  ·  2019-08-03 23:52:49 +08:00
    做了个 springfox 的扩展项目[SpringFox-Plus]( https://github.com/hadix-lin/springfox-plus),可以读取 javadoc 作为接口文档,替代部分 swagger 注解的使用。

    项目的 README 有使用说明,请有空的朋友帮忙测试一下,提提意见。
    67 条回复    2019-08-03 12:47:16 +08:00
    Ahaochan
        1
    Ahaochan  
       2019-08-01 19:40:18 +08:00
    A、A、null、null
    zjp
        2
    zjp  
       2019-08-01 19:55:19 +08:00
    A、A、null、null
    OctopusGO
        3
    OctopusGO  
       2019-08-01 20:15:32 +08:00 via Android
    A、A、null、null
    wym7223645
        4
    wym7223645  
       2019-08-01 20:43:36 +08:00
    A、A、null、null
    leon0903
        5
    leon0903  
       2019-08-01 20:46:13 +08:00
    D(Go)、C、null、nul
    FreeEx
        6
    FreeEx  
       2019-08-01 20:47:35 +08:00 via iPhone
    A,A,无,可自定义返回值样例。
    aliensb
        7
    aliensb  
       2019-08-01 20:47:47 +08:00 via Android
    @leon0903 做 Go 的老哥不应该是 nil 吗?手动滑稽
    WispZhan
        8
    WispZhan  
       2019-08-01 20:50:08 +08:00
    1. A、C
    2. A、B、C (手工 Markdown/Asciidoc 文档 + B )
    3. null
    4. 最好重新定制一个 UI,v2.x 的新 UI 操作逻辑成迷,老 UI 渲染方式蛋疼,大文档就直接卡了
    StarkWhite
        9
    StarkWhite  
       2019-08-01 21:02:33 +08:00
    A, B, null, null
    arrow8899
        10
    arrow8899  
       2019-08-01 21:06:14 +08:00
    A&B, B, None, None
    ddddad
        11
    ddddad  
       2019-08-01 22:02:26 +08:00
    A,A,高版本的 UI 反而不那么方便,null
    hadixlin
        12
    hadixlin  
    OP
       2019-08-01 22:08:25 +08:00
    感谢大家参与这个问卷,到目前为止有 402 次点击,11 个回复。

    可见 swagger 的用户还是挺多的。

    我也觉得新版的 ui 对文档展示不太紧凑,看起来并不十分方便,定制 ui 还是很有价值。
    msaionyc
        13
    msaionyc  
       2019-08-01 22:13:13 +08:00
    A、A、""、""
    wugn
        14
    wugn  
       2019-08-01 22:18:58 +08:00 via Android
    A,B,null,null
    allanzhuo
        15
    allanzhuo  
       2019-08-01 22:45:06 +08:00
    A、A、null、null
    xaplux
        16
    xaplux  
       2019-08-01 23:08:18 +08:00
    A、A、null、null
    定制 ui 貌似有个 bootstrap-ui
    hadixlin
        17
    hadixlin  
    OP
       2019-08-01 23:50:58 +08:00 via iPhone
    @xaplux 乍看起来是个很棒的 ui,有空试试
    lingxi27
        18
    lingxi27  
       2019-08-01 23:52:30 +08:00
    d b null null
    xaplux
        19
    xaplux  
       2019-08-01 23:53:09 +08:00
    @hadixlin 这个我也没用过,目前我们是 spring boot + springfox-swagger,感觉还算够用
    515576745
        20
    515576745  
       2019-08-01 23:54:52 +08:00 via Android
    第一次听说 springfox
    RTNelo
        21
    RTNelo  
       2019-08-01 23:56:33 +08:00
    B B None None
    tinytin
        22
    tinytin  
       2019-08-02 00:38:32 +08:00 via iPhone
    springfox-swagger 和 swagger api 并不完全是一个东西
    hotsymbol
        23
    hotsymbol  
       2019-08-02 01:14:19 +08:00
    D ( Golang ),B,nill,nill
    seven123
        24
    seven123  
       2019-08-02 08:25:04 +08:00
    B B None None
    monstervivi
        25
    monstervivi  
       2019-08-02 08:45:46 +08:00
    A、A、null、null
    IvanLi127
        26
    IvanLi127  
       2019-08-02 09:16:37 +08:00 via Android
    TS、NEST.JS 、Null、Null
    bxqqq
        27
    bxqqq  
       2019-08-02 09:26:27 +08:00
    B B redoc. None
    kkkkkrua
        28
    kkkkkrua  
       2019-08-02 09:29:20 +08:00
    SpringFox 第一次听说
    你们不觉得在代码里面些一堆注解很难看么。还是觉得用 springrestful 生成离线文档好点
    90d0n
        29
    90d0n  
       2019-08-02 09:31:51 +08:00
    A、A、null、"分类排序, 接口排序, 参数排序等排序功能; 搜索功能;"
    ipeony
        30
    ipeony  
       2019-08-02 09:38:05 +08:00
    AC、A、Go 直接手写 yaml、UI 好看点?
    lemonEssence
        31
    lemonEssence  
       2019-08-02 09:40:00 +08:00
    A B null null
    mirrorpen
        32
    mirrorpen  
       2019-08-02 09:41:42 +08:00
    D(PHP)、B、null、null
    amon
        33
    amon  
       2019-08-02 09:41:53 +08:00
    之前用过 swagger,SpringFox 相比之前有什么变化吗?
    Beeethoven
        34
    Beeethoven  
       2019-08-02 10:33:46 +08:00
    A B 有没有人推荐一下 yaml 的生成工具.. 手写的头皮发麻
    kiddingU
        35
    kiddingU  
       2019-08-02 12:36:00 +08:00
    @Beeethoven 代码直接生成咯,手写格式对齐搞死你。。。
    lonfall
        36
    lonfall  
       2019-08-02 14:35:36 +08:00
    A A NULL NULL
    SkyLine7
        37
    SkyLine7  
       2019-08-02 16:06:25 +08:00
    A A undefined undefined
    ily433664
        38
    ily433664  
       2019-08-02 16:19:03 +08:00
    A、A、null、null
    Encloud
        39
    Encloud  
       2019-08-02 16:31:20 +08:00
    D(Node)、B、null、null
    liuxey
        40
    liuxey  
       2019-08-02 16:32:05 +08:00
    null, null, null, null

    cweijan
        41
    cweijan  
       2019-08-02 16:34:08 +08:00
    Swagger 有其他的替代品吗
    Rwing
        42
    Rwing  
       2019-08-02 16:53:20 +08:00
    C#、null、null、null
    gerorim
        43
    gerorim  
       2019-08-02 16:56:07 +08:00 via iPhone
    B, drf-yasg, 3.x Swagger UI 缺少 JSON editor, null
    ckrv2
        44
    ckrv2  
       2019-08-02 17:15:14 +08:00
    A B
    diferent
        45
    diferent  
       2019-08-02 17:16:24 +08:00
    B A NULL NULL
    run27017
        46
    run27017  
       2019-08-02 17:26:50 +08:00 via iPhone
    swagger 文档我一直在用,我现在还是在用我一年前 写的项目,

    http://run27.top/swaggerhuge
    Lindp
        47
    Lindp  
       2019-08-02 17:29:40 +08:00
    A、A、null、可以定制 UI
    utf16
        48
    utf16  
       2019-08-02 17:32:24 +08:00
    if(isSwagger) return;
    ErrorMan
        49
    ErrorMan  
       2019-08-02 18:50:40 +08:00 via Android
    A, A, null, null
    SmithCruise
        50
    SmithCruise  
       2019-08-02 19:27:44 +08:00
    A、A、null、null
    hadixlin
        51
    hadixlin  
    OP
       2019-08-02 20:45:23 +08:00 via iPhone
    @run27017 swaggerhuge 这个项目是做什么的?本来想体验一下的,要注册,把我挡住了
    24bit
        52
    24bit  
       2019-08-02 20:56:19 +08:00
    A、A、null、null
    GavinHua
        53
    GavinHua  
       2019-08-02 21:05:52 +08:00 via Android
    接口的变更记录,正打算造个轮子
    secsilm
        54
    secsilm  
       2019-08-02 21:12:58 +08:00
    想问下,Python 怎么用 swagger ?
    run27017
        55
    run27017  
       2019-08-02 22:09:53 +08:00 via iPhone
    @hadixlin 模拟 swaggerhub 的,私人文档,支持团队协同。

    注册只用输入用户名密码就好了,都没有验证。
    wo642436249
        56
    wo642436249  
       2019-08-02 22:20:40 +08:00 via Android
    1.go 、php
    2.大众方式
    3.nil 、null
    4.我想问问用 java 只要求能做项目,能解决大多数问题,是不是简单会个 spring 就行了😂熟练了基本不用自己写代码,全都加载其他大神的包就行
    cz5424
        57
    cz5424  
       2019-08-02 22:43:26 +08:00
    python 在测试用例 hook 了一下生成出了 swagger 文档,然后发现这东西没啥用,甚至觉得很鸡肋
    hadixlin
        58
    hadixlin  
    OP
       2019-08-02 23:56:33 +08:00
    @wo642436249 你的 4 是在讲段子吗?
    hadixlin
        59
    hadixlin  
    OP
       2019-08-02 23:57:37 +08:00
    @GavinHua 这个主意很棒,是不是可以结合 git 提交历史来做?
    hadixlin
        60
    hadixlin  
    OP
       2019-08-03 00:04:38 +08:00
    @run27017 试用了一下,喜欢直接用 Swagger 规范编写 API 文档,用这个还是挺好的。

    我个人是推崇从代码生成文档的,文档应当作为代码的一部分存,我想做的项目也是要简化编码中嵌入文档的工作。
    hadixlin
        61
    hadixlin  
    OP
       2019-08-03 00:05:58 +08:00
    @cz5424 文档是沟通工具,如果没有需要沟通的目标,那真是鸡肋。
    xuanbg
        62
    xuanbg  
       2019-08-03 07:37:38 +08:00
    Java,但不用 swagger,手写 md 接口文档
    wo642436249
        63
    wo642436249  
       2019-08-03 07:42:48 +08:00 via Android
    @hadixlin 😂我的 4 在提问啊
    run27017
        64
    run27017  
       2019-08-03 08:30:08 +08:00
    @hadixlin 嗯,其实我也一直推崇代码即文档,但一直没有找到适合的方案。

    你现在在做的东西是什么?是要造一个轮子吗?我看是 Spring 上的,我本人并不用 Spring.
    arthas2234
        65
    arthas2234  
       2019-08-03 09:27:42 +08:00
    A,A,null,可以方便的修改默认 url;现阶段 ui 接口排序太乱
    hadixlin
        66
    hadixlin  
    OP
       2019-08-03 12:44:13 +08:00
    @kkkkkrua 注解是有点儿难看,所以我想做个扩展,直接读取代码的 javadoc 作为接口文档。
    hadixlin
        67
    hadixlin  
    OP
       2019-08-03 12:47:16 +08:00
    @run27017 swagger 有一些第三方工具可以针对各种框架和语言自动生成文档的,springfox 就是针对 springmvc 的 swagger 文档生成工具。用了一段时间还不错,就是注解有点儿烦人,不那么好用,我想做个扩展直接读静态的 javadoc 出来作为接口文档。
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   3990 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 26ms · UTC 07:22 · PVG 15:22 · LAX 00:22 · JFK 03:22
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.