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

地址

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

官网: www.showdoc.com.cn/

更新内容:

可设置全站项目要求登录后方可访问
上传图片附件到oss的时候支持设置子目录
更换了一个更好看的图片预览插件
优化编辑交互体验
修复导入json文件的bug
修复程序注释生成API文档的bug
修复水印生成时候不能全屏的bug

如何操作

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

介绍

ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版( github 1 万+ 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 开发相关的进阶知识。
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
讨论数量: 7

额,加油!

4个月前 评论

我也在用,点赞

4个月前 评论

用过感觉不是很方便,目前在用 apidoc
不过要是字段不是按照模型的话,还是showDoc, apidoc 适合自定义字段不多的时候,很爽

4个月前 评论
star7th (楼主) 4个月前
star7th (楼主) 4个月前
沈小明 (作者) 4个月前
qianfan 4个月前

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