ShowDoc v3.3.0 发布， IT 团队的在线 API 文档、技术文档工具

[star7th]

地址

开源地址： https://github.com/star7th/showdoc

官网： https://www.showdoc.com.cn/

更新内容：

可设置全站项目要求登录后方可访问

上传图片附件到 oss 的时候支持设置子目录

更换了一个更好看的图片预览插件

优化编辑交互体验

修复导入 json 文件的 bug

修复程序注释生成 API 文档的 bug

修复水印生成时候不能全屏的 bug

如何操作

更新步骤请参考请参考手册的升级安装部分： https://www.showdoc.com.cn/help?page_id=13732

介绍

ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具，既有开箱即用的在线托管服务版，也有免费的开源版( github 1 万+ star )。通过 showdoc ，你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档，你还可以利用 showdoc 的自动化能力，从程序注释中自动生成 API 文档，或者从搭配的 RunApi 客户端（类似 postman 的 api 调试工具）中一边调试接口、一边自动生成文档。无需手动编写文档，释放生产力。通过分配项目成员和团队成员，你可以很方便地进行项目文档的权限管理和团队协作，也可以分享文档出去给朋友查看。ShowDoc 还支持多平台客户端，有 win 客户端、mac 客户端、ios 、android 等，更方便跨平台使用。目前超过 100000+的互联网团队正在使用 showdoc ，包括知名公司内部的一些团队，比如腾讯、华为、百度、京东、字节跳动等等。

关于 Showdoc 的详细介绍，请看： https://www.showdoc.com.cn/help

[Pdk5a8759cbeD6CH]

以前短暂用过，现在我们用 rpc 直接不用文档，字段注释就行了

[flyingcrp]

目前最优解应该是 apifox apipost 这样的产品。

[star7th]

@flyingcrp

showdoc 也有配套工具对标你说的这些产品 https://www.showdoc.com.cn/runapi

[flyingcrp]

@star7th 很棒，但是功能太简陋了。完全无法做到同 runapi 来替换掉 api 的管理和维护。但感谢推荐。我早期也是用 showdoc ，后来管理上确实满足不了，所以放弃了。很高兴看到 showdoc 能走出这一步。

[star7th]

@flyingcrp 为啥说 runapi 没法替换掉 api 的管理和维护，少了哪些你觉得必不可少的功能

[flyingcrp]

@star7th 个人愚见，api 的管理涉及到协同(任务管理，尤其是互相的联动状态切换)。api 只是研发之间的管理(如果不是为了提效，要不要 API 管理意义都不大，尤其是非远程团队)。没有进入到协作之间的管理这是根本。没有解决这个问题之前，所有的 api 管理工具都只是 swagger 的套壳或者体验优化，目前接触到的工具都是在自己这一块儿废了比较多的经历，但是几乎都没考虑过协作；

[star7th]

@flyingcrp

我没理解你的意思。你一方面说最优解是 apifox apipost 这样的产品。 然后我指出了另一个类似产品 runapi 。
但是你又说所有 api 管理工具都不符合需求。
或者我只能理解你不是 需要 api 管理 的目标群体了。