V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
这是一个专门讨论 idea 的地方。

每个人的时间,资源是有限的,有的时候你或许能够想到很多 idea,但是由于现实的限制,却并不是所有的 idea 都能够成为现实。

那这个时候,不妨可以把那些 idea 分享出来,启发别人。
page470075640
V2EX  ›  奇思妙想

一个想法:通过中间层代理来解析 API 输入/输出,自动生成 swagger 文档

  •  1
     
  •   page470075640 · 2022-08-22 15:57:22 +08:00 · 1985 次点击
    这是一个创建于 809 天前的主题,其中的信息可能已经有所发展或是发生改变。
    代理目标是 API test code ,想知道有现成的这类工具吗?如果没有我就打算尝试一下。。。
    10 条回复    2022-08-23 19:00:23 +08:00
    jstony
        1
    jstony  
       2022-08-22 17:29:02 +08:00
    感觉意义不大,一般不是应该文档先行吗?
    luvroot
        2
    luvroot  
       2022-08-22 17:35:27 +08:00
    grpc reflect 现在就支持
    xaplux
        3
    xaplux  
       2022-08-22 17:41:51 +08:00
    接口描述,参数描述等获取不到吧,感觉这个还是比较重要的
    page470075640
        4
    page470075640  
    OP
       2022-08-22 18:16:16 +08:00
    @jstony 不同的开发方式吧。。。我这边都是写完测试代码后才开始写文档的

    @luvroot 能贴一下项目链接吗?

    @xaplux 参数描述确实是个问题,目前的想法是通过变量的语义和错误信息来说明这个问题。
    luvroot
        5
    luvroot  
       2022-08-22 18:42:25 +08:00
    wdwwtzy
        6
    wdwwtzy  
       2022-08-22 18:44:42 +08:00
    不太明白,写注释的时候,不就是写好了 swagger 文档吗?是其他语言不行吗?.net 就是注释就是 swagger 文档
    luvroot
        7
    luvroot  
       2022-08-22 18:50:24 +08:00
    一般都是通过写注释写好了 由工具生成 swagger json 。
    还有一种完全不写注释,比如 grpc 的这种通过 reflect 找到接口名字和参数,只提供接口名和参数展示
    page470075640
        8
    page470075640  
    OP
       2022-08-22 19:42:48 +08:00 via iPhone
    结贴:通过注释或者 grpc 能自动生成 swagger ,谢谢各位答疑解惑
    kkeep
        9
    kkeep  
       2022-08-22 20:07:12 +08:00 via Android
    已经有了
    ternice
        10
    ternice  
       2022-08-23 19:00:23 +08:00
    swagger 感觉只适合 个人开发或者独立开发
    实际项目 接口设计和接口实现就不是一个人,都是先有文档才有接口
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   970 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 19:58 · PVG 03:58 · LAX 11:58 · JFK 14:58
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.