V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
whitecosm0s
V2EX  ›  分享创造

[送兑换码] MacOS 上的接口文档生成和调试工具 RabiAPI 更新 1.3.3 版本,集成 ApidocJS 框架,支持对所有主流编程语言自动生成 API 文档!

  •  
  •   whitecosm0s · 2021-02-08 15:36:48 +08:00 · 1195 次点击
    这是一个创建于 556 天前的主题,其中的信息可能已经有所发展或是发生改变。

    RabiAPI 之前仅支持 Java 项目,很多人反馈希望能够支持其它语言。本次更新中集成了 apidoc-core 框架。可以直接添加使用了 apidoc 的项目。

    ** 应用原价 60 元,目前半价 30 元 骨折销售中 **

    购买地址: https://apps.apple.com/cn/app/rabiapi/id1524200727

    详细介绍: https://github.com/RabiAPI/RabiAPI-Support

    其它更新:

    1. Http Client 增加参数是否必填提示,仅作提示用。
    2. Http Client 增加是否存在参数提示,如果相关菜单存在参数,作蓝色圆点标记
    3. 优化在 13 寸分辨率下的显示效果
    4. 支持多窗口,通过 command + N 打开新窗口

    ApidocJS 简介

    ApidocJS 是一个通过注释信息直接生成 API 文档的开源框架,通过正则表达式解析特定写法的注释并生成一个静态站点,理论上支持所有语言。

    写法示例,定义一个 GET 请求

    /**
     * @api {get} /user/:id Request User information
     * @apiName GetUser
     * @apiGroup User
     *
     * @apiParam {Number} id Users unique ID.
     *
     * @apiSuccess {String} firstname Firstname of the User.
     * @apiSuccess {String} lastname  Lastname of the User.
     */
     
     ... code
    

    写法基本就是这样,通过自定义的 Tag 和格式填写 API 信息。

    优点: 写法简单,对代码无侵入,无额外依赖,适合简单 API 接口。

    缺点: Postman 和 Paw 均不支持 apidoc json 文件的导入,本身生成的静态站点仅具备展示功能。由于使用的是注释导致很难定义特别复杂的接口。

    官网: https://apidocjs.com/

    Github: https://github.com/apidoc/apidoc 目前 8.8K Star

    应用预览

    img

    img

    img

    img

    技术支持

    QQ 支持群 244365684

    微信 superwhitecosmos

    邮箱 [email protected]

    发送邮件最好注明 [ RabiAPI ] ,方便我及时回复您

    100 个产品兑换码,请在 Mac App Store 中兑换

    1. XNWLXWXL47MF
    2. NXT964FP9H67
    3. LJA6MPFMPET3
    4. EP7WLF37K6XT
    5. JWTNLJJ7TKYA
    6. HAMFTL3K6JMW
    7. 796YXY3997HN
    8. LXK47X3NKMHF
    9. TN6MPM37TNWL
    10. PXJHE4L4WYAW
    11. YH7NLX6NE4XN
    12. J6RYEXYTTAN7
    13. 4JH9AEM774NN
    14. WN9JT9LAJ339
    15. XRMR7KHJKNEX
    16. YHNXYW997WNA
    17. HYTPMHW7P3J4
    18. XFHEETKK96T4
    19. JRRLPF6WXAW3
    20. NXL3J7JN9R4W
    21. LWRYJNW43PY6
    22. A979FXERRRKH
    23. TEYYRE9MPJLA
    24. A3FMYAE7K7FX
    25. 4JFR3PKFALP9
    26. X3WKKMPA4KY6
    27. AMTAT6RRPEX4
    28. AERTM674FPAY
    29. MR3YL4LJHAYX
    30. WPXJ946NAP7H
    31. NW97RP4WW693
    32. 9HY4PRJNKKRP
    33. PLYL649EFFJN
    34. 67J9L9K66PF9
    35. RWM46KNJ9XTF
    36. 4F9KHXY9XN4J
    37. WJN74FEAKNTT
    38. WJ7J4KJHF7Y9
    39. LL3JP669YJY7
    40. H9767493WF9Y
    41. YANENJKE7933
    42. 4F3RHHHPKN9A
    43. M6PX4FT4X6YX
    44. 7EYJR4RATX9F
    45. 9M3WKF7EXYFK
    46. TFENKL4T4WL9
    47. 99R6NKWJ3KE6
    48. XTYMRJK4LLKR
    49. 63JTXNJWJXF3
    50. AXLLX7NRWTYR
    51. HAY3AM9XNJX6
    52. FT7T4P9ETK39
    53. 36JNNY44FFJP
    54. M7MRA6MRKEAM
    55. NT3ANNKF99LW
    56. HM77WNX3J99H
    57. 7A69N3694JFN
    58. X9PK3N6MP4YA
    59. MJYMAHXHNHPN
    60. 4LMH9W49FMER
    61. N9XFH3RRKYXK
    62. 4HH6ATFA4MFW
    63. 7T9464TJ7F3X
    64. KLTKP4MT969F
    65. THM9RKWHMXFR
    66. PYLTT6WHYFMP
    67. TMRHMMEA9KYR
    68. 3JFWHRMEEK9W
    69. YNHJPPF3KJWP
    70. 7PATFKWEP77Y
    71. N3FRFW6HJYMX
    72. K4A6PNNTNRLA
    73. 79FNAT3PPMAL
    74. 3NM6R4MPF4XR
    75. FWN94MH96T4P
    76. KAW7MJPANPX7
    77. KX7NLPEEE9MT
    78. FPLXKMPTRAX4
    79. AEWNK43N6MMF
    80. KXET7WXXKMAE
    81. 9ANRWFEHLFRA
    82. XXRK7NMEARW4
    83. MFTKXH49F7PM
    84. F6JW7HAX7J9R
    85. EJJ3XFJL9XY9
    86. 7ERNAHTERT36
    87. YHPKE36JE49X
    88. RTT3YN77PPPX
    89. 9K9JL94FPFLK
    90. Y3HYMK3MFYTL
    91. MPLXE3YEMA33
    92. WW6RJ6FRNRYN
    93. 77PRK3ANX4HT
    94. FYFY7T3LK3TE
    95. A4JJRARA3TRA
    96. RHFL6RR443YH
    97. KEYTY6Y6AREM
    98. LX3MLRJRRNX3
    99. 9FJ7PNJN93WT
    100. LE3YHYKYEL4A
    9 条回复    2021-02-09 17:30:11 +08:00
    coderwl
        1
    coderwl  
       2021-02-08 15:42:10 +08:00
    AMTAT6RRPEX4 已用,多谢楼主
    flycn1985
        2
    flycn1985  
       2021-02-08 15:55:05 +08:00
    X9PK3N6MP4YA 已用
    Hedgeh09
        3
    Hedgeh09  
       2021-02-08 16:13:00 +08:00
    9FJ7PNJN93WT 已用,感谢楼主
    undertonememorie
        4
    undertonememorie  
       2021-02-08 16:38:53 +08:00
    4LMH9W49FMER 已用,感谢楼主
    LoNeZ
        5
    LoNeZ  
       2021-02-08 16:44:02 +08:00
    LWRYJNW43PY6 已用 感谢楼主
    Vvictor
        6
    Vvictor  
       2021-02-08 18:48:44 +08:00
    K4A6PNNTNRLA 已用感谢楼主
    branchzero
        7
    branchzero  
       2021-02-09 00:38:50 +08:00
    9ANRWFEHLFRA 已用,感谢楼主
    icewent
        8
    icewent  
       2021-02-09 09:52:05 +08:00
    HAY3AM9XNJX6 已用,感谢楼主
    imrei
        9
    imrei  
       2021-02-09 17:30:11 +08:00
    (´・_・`) 感谢楼主,不过刚刚兑换时出了点小问题,忘记用的是哪个兑换码了。。。
    关于   ·   帮助文档   ·   API   ·   FAQ   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   3293 人在线   最高记录 5497   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 137ms · UTC 10:32 · PVG 18:32 · LAX 03:32 · JFK 06:32
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.