ShowDoc v2.6.1 发布,IT 团队的在线 API 文档工具

xingchen
 xingchen
发布于 2020年02月11日
收藏 15

更新内容:

showdoc正式支持plantuml,包括时序图、用例图、类图、组件图、状态图等等。你可以使用markdown代码块声明plantuml,然后中间插入plantuml语句。详情请看文档https://www.showdoc.cc/p/69d2f7ad6306f13363bb803e755068c7


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

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

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。
转载请注明:文章转载自 OSCHINA 社区 [http://www.oschina.net]
本文标题:ShowDoc v2.6.1 发布,IT 团队的在线 API 文档工具
加载中

最新评论(30

Javen-IJPay
Javen-IJPay
为开源做贡献是支持的,但在其他开源项目下乱发广告这种推广方式令人…(手动和谐)
xingchen
xingchen
怎么说呢,目的是给开源的作者看的。如果他有留邮箱,我就会发邮箱去了。至于评论等,作者觉得形成打扰了他会删除的。
Javen-IJPay
Javen-IJPay
已举报 😱 看官方怎么回复吧 如果官方支持这么操作我没有意见哈....
xingchen
xingchen
比如说针对你的IJPay来说。我个人觉得,IJPay当前文档的阅读体验还是略差一些的。比如说,有大量无关信息,把重要的不重要的类和方法都生成文档了。其次UI也不美观,看起来有点像十几年前web1.0的风格。这只是我个人想法,我觉得你的项目挺多人用的,可以把文档弄得更好一些,阅读体验更棒一些。所以就跟你推荐showdoc了。如果你觉得showdoc不合适使用,也没关系。我已经关闭那个issue了
Javen-IJPay
Javen-IJPay
其一不要偏低别人的项目而抬高自己的项目,王婆卖瓜自卖自夸,容易招黑。其二不同场景使用的解决方案不同而已,IJPay 文档使用的是 vuePress 可以直接 build 成静态页面扔到page上,而你开源的不能而且必须依赖服务器中Docker环境或者PHP环境。
Javen-IJPay
Javen-IJPay
其三你说UI丑,这只是你个人的审美,为什么 vuePress 使用人数比你多呢?这个问题想过没有… IJPay 文档使用的默认UI 没有自定义而已,你开源的可以自定义么?其四酒香不拍巷子深,好用都会慕名而来的,做好自己的需求定位完善好功能比什么都强
xingchen
xingchen
好的,打扰了。
xingchen
xingchen
我知道你已经有点反感推荐了。所以我不推荐了。现在是纯建议,建议你在现在的基础上换个vuePress 主题或者尝试自定义,会有利于提供你的项目文档的阅读体验。另外可以尝试减少一些生成的信息,突出重点,容易让用户一目了然。我做过多年的用户体验型产品,仅仅是直觉上告诉我这样做会提高用户体验。假如你觉得我的建议还是很不靠谱,你可以尝试做一下用户调研,看看用户的想法。或者就此打住,我们不再就此问题讨论,你可以完全忽略我的建议。
xingchen
xingchen
我觉得程序员一般是一个实事求是的群体。如果一个工具能让自己的项目变得更好,何必反感他人的推荐呢。我觉得使用showdoc的效果真的会比现存的文档会体验好一些。只是说不知道你是否愿意花点心思做出一点点改变。我只是推荐而已。用不用还是你的想法。
qingfeng346
qingfeng346
有没有那种没有url请求,单纯一个api列表的生成工具
开源中国首席老司机
开源中国首席老司机
实事求是的说,只支持sqllite且不支持mysql,是一个倒退。
xingchen
xingchen
实事求是的说,只支持sqllite且不支持mysql,是一个利大于弊的选择。因为php自带对sqllite的支持,对用户来讲,什么都不用操作就可以开箱使用了。
xingchen
xingchen
而且,showdoc的一半用户不懂怎么安装mysql或者不知道如何连接php与mysql。放弃这个包袱能容纳跟广泛的群体。我并不只看php开发者群体。
y
yh2216
为啥?一个软件如果使用数据库作为业务的解决方案,那么这个数据库必须是有DBMS的数据库?
y
yh2216
依据业务需求,只要能够很方便的解决问题,那么使用更加合理的sqlite 有何不可?非得用十分臃肿的大型数据库吗?
开源中国首席老司机
开源中国首席老司机
什么叫臃肿的大型数据库?mysql已经到这个份上了?
mysql在数据管理维护上,也会比sqllite方便点吧。
而且看清楚我的说的“只支持sqllite且不支持mysql”

如果能支持mysql的话,对ShowDoc 进一步发展还是有莫大的好处的
y
yh2216
这个还是得看业务,如果业务不需要,则不需要使用大型数据库!
xingchen
xingchen
支持mysql对showdoc没什么发展好处。该用showdoc的还是会用,不用showdoc的不会因为支持mysql而用。反而引起mysql增加了麻烦。一件事可以用简单的方式解决,就不需要增加复杂度。你如果要从维护的角度来讲,那么,如果要备份数据库,就简单把整个代码复制一份就好了。我想不到比这个更好维护的了。
开源中国首席老司机
开源中国首席老司机
曾几何时showdoc的后台不完善的时候,需要在线上库里调整下数据的时候........
xingchen
xingchen
以前是以前。现在早已经有管理后台了。
溱
有毒啊,一进网页CPU就100%
xingchen
xingchen
没理解你说什么,进入哪个网页,浏览器还是服务器的cpu满了
溱
https://www.showdoc.cc/ 是这个地址
xingchen
xingchen
我没遇到过cpu满了的情况,也没听过有其他人反馈这类的问题
lanmingle
lanmingle
Yapi了解一下
不会飞的小龙人
Yapi的文档编辑不如showdoc友好,经常编辑修改保存好后,容易打乱内容或格式,又要回去调整一下内容或格式,也要可能是我用的不够深入。yapi但也算是不错的开源产品;以前用apizza,算是比较优秀的在线文档,但收费后就弃了。
郭剑波
郭剑波
可以方便的导入 Postman导出的接口格式, https://www.cnblogs.com/chendeming/p/11582715.html
郭剑波
郭剑波
能支持导入Postman就好了
yybawang
yybawang
比较抽象,且说api请求地址在markdown里怎么正确解析出真正的接口地址?每份文档的写法都不一样
xingchen
xingchen
导入Postman应该是可以的,后面再看下吧。
返回顶部
顶部