开源地址: https://github.com/star7th/showdoc
官网: https://www.showdoc.com.cn/
1 ,安全更新
2 ,增加页面修改提醒功能,可通知指定的项目成员
3 ,增加项目变更记录功能(查看入口在项目主页的右侧工具栏的更多展开按钮中)
4 ,可以导入文件(postman/swagger/markdown 压缩包)到已存在的项目内,也可以重复导入以覆盖更新
5 ,优化注释生成文档功能
6 ,支持通过 s3 协议上传附件
1 ,修复导入 swagger 文件的问题
2 ,修复点击文件库错误的问题
3 ,支持 runapi 客户端的错误返回示例
4 ,支持 runapi 客户端的搜索功能
5 ,支持 runapi 客户端的 query 和路径变量功能
6 ,可一键设置团队的成员项目权限为只读
7 ,选择目录时候可输入关键字搜索目录
8 ,在编辑页面时候可跳转去新建目录
9 ,完善页面排序功能
10 ,修复 xss 安全漏洞
11 ,解决 TOC 目录遮挡图标的问题
12 ,支持 runapi 客户端的接口状态功能
13 ,支持 runapi 客户端的全局 cookies 功能
14 ,支持 runapi 客户端的全局脚本功能
更新步骤请参考请参考手册的升级安装部分: https://www.showdoc.com.cn/help?page_id=13732 showdoc 介绍
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
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.