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

21 小时 59 分钟前
 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

381 次点击
所在节点    分享创造
3 条回复
dylanqqt
20 小时 36 分钟前
以前短暂用过,现在我们用 rpc 直接不用文档,字段注释就行了
flyingcrp
19 小时 35 分钟前
目前最优解应该是 apifox apipost 这样的产品。
star7th
18 小时 50 分钟前
@flyingcrp

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

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1085321

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX