V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
这是一个专门讨论 idea 的地方。

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

那这个时候,不妨可以把那些 idea 分享出来,启发别人。
page470075640

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

  •  1
     
  •   page470075640 · Aug 22, 2022 · 2771 views
    This topic created in 1349 days ago, the information mentioned may be changed or developed.
    代理目标是 API test code ,想知道有现成的这类工具吗?如果没有我就打算尝试一下。。。
    10 replies    2022-08-23 19:00:23 +08:00
    minibear2021
        1
    minibear2021  
       Aug 22, 2022
    感觉意义不大,一般不是应该文档先行吗?
    luvroot
        2
    luvroot  
       Aug 22, 2022
    grpc reflect 现在就支持
    xaplux
        3
    xaplux  
       Aug 22, 2022
    接口描述,参数描述等获取不到吧,感觉这个还是比较重要的
    page470075640
        4
    page470075640  
    OP
       Aug 22, 2022
    @jstony 不同的开发方式吧。。。我这边都是写完测试代码后才开始写文档的

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

    @xaplux 参数描述确实是个问题,目前的想法是通过变量的语义和错误信息来说明这个问题。
    luvroot
        5
    luvroot  
       Aug 22, 2022
    wdwwtzy
        6
    wdwwtzy  
       Aug 22, 2022
    不太明白,写注释的时候,不就是写好了 swagger 文档吗?是其他语言不行吗?.net 就是注释就是 swagger 文档
    luvroot
        7
    luvroot  
       Aug 22, 2022
    一般都是通过写注释写好了 由工具生成 swagger json 。
    还有一种完全不写注释,比如 grpc 的这种通过 reflect 找到接口名字和参数,只提供接口名和参数展示
    page470075640
        8
    page470075640  
    OP
       Aug 22, 2022 via iPhone
    结贴:通过注释或者 grpc 能自动生成 swagger ,谢谢各位答疑解惑
    kkeep
        9
    kkeep  
       Aug 22, 2022 via Android
    已经有了
    ternice
        10
    ternice  
       Aug 23, 2022
    swagger 感觉只适合 个人开发或者独立开发
    实际项目 接口设计和接口实现就不是一个人,都是先有文档才有接口
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   2458 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 35ms · UTC 15:21 · PVG 23:21 · LAX 08:21 · JFK 11:21
    ♥ Do have faith in what you're doing.