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

更新内容:

1,修复若干个安全漏洞。
2,升级flowchart.js版本,支持绘制更多图表
3,用户修改密码后,其他设备的登录token会失效
4,全局搜索的时候可以搜索项目名字和文档内容
5,修复编辑器若干bug
6,表格项目的锁定逻辑修复

更新步骤请参考请参考手册的升级安装部分:

www.showdoc.com.cn/help?page_id=13...

showdoc介绍

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

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

本作品采用《CC 协议》,转载必须注明作者和本文链接
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
《L04 微信小程序从零到发布》
从小程序个人账户申请开始,带你一步步进行开发一个微信小程序,直到提交微信控制台上线发布。
讨论数量: 14

点个赞,就是 RunApi 用起来有点不太方便

2个月前 评论

@haodudecao runapi哪里不方便

2个月前 评论
haodudecao 2个月前
邢闯洋 2个月前
star7th (作者) (楼主) 2个月前

什么时候能支持 yapi 那样的一键导入

2个月前 评论

@22 在showdoc新建项目,文件导入。

2个月前 评论

已经改APIpost了。 :joy:

1个月前 评论

@bigdaxin 为啥

1个月前 评论
bigdaxin 1个月前
star7th (作者) (楼主) 1个月前
bigdaxin 1个月前
zhanghaidi 1周前
star7th (作者) (楼主) 1周前
star7th (作者) (楼主) 1周前

挺好的,很久之前用过。唯一缺点就是不再支持主流的mysql数据库,而选择小众的Sqlite。PHP程序员基本上是与mysql打交道,而不会选择用Sqlite

1个月前 评论

@apud 如果你只是产品使用者而非showdoc本身的二次开发者,我觉得用sqlite更好,用户无感知,你不需要接触数据库。如果你是需要二次开发才关心数据库。实际上绝大部分人都是产品使用者。

1个月前 评论
apud 1个月前
star7th (作者) (楼主) 1个月前

目前在使用中,要求不高,公司内部记录些文档,可以共享,完全够用。

1个月前 评论

当接口返回新字段时,重新复制返回示例,然后点击快速生成,有的时候会清空参数说明的注释。还有就是不想快速生成的时候能不能支持 markdown 的格式编辑,比如我有2个接口返回的参数格式差不多,我就可以复制上一个接口的参数格式,粘贴修改就行了,而不是快速生成的时候又一个个的注释说明

1个月前 评论

@KarlHsu 你说的这种情况后续更新看下怎么做好

1个月前 评论

apifox的在线文档也很好用呀

1周前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!