search

star7th / showdoc

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具
https://www.showdoc.com.cn
Other
12.18k stars 2.18k forks source link

runapi生成的文档无法通知 #2139

Open baiyu5484556 opened 7 months ago

baiyu5484556 commented 7 months ago

作为一个使用showdoc五年的老用户,目前有些比较疑惑 1.界面修改能否支持选择指定界面类似于分享增加通知功能 2.通知功能支持多样化, 希望集成两种, 1): showdoc站内信通知, 2): 自定义接口,客户自定义消息发送接口,类似于runapi里面的后置发送请求一样

baiyu5484556 commented 7 months ago

目前runapi生成的接口文档,如果变更了 不知道怎么通知

star7th commented 7 months ago

一般来讲，一个团队内部总会有类似 微信 ，企业微信 ，钉钉 这样的通讯软件。 我设想的通知场景是： 把runapi生成后的文档链接，复制然后发给对方。 showdoc网页版是有站内通知功能的。但是我发现使用率极低，以至于我都不怎么想移植到runapi客户端去了。更别说提供hook接口了。 我自己本人都不确定，这是刚需，还是说简单在微信上说一句发个链接就能解决的问题。

baiyu5484556 commented 7 months ago

您说的没错,对于通知来说,本身属于辅助业务,但是runapi生成的接口,如果接口变更了,只能通过复制链接的方式手动通过第三方通信工具通知,而无法通过站内信的方式通知; 其实这个有点矛盾,都是通知,只是模式不一样; 但是还是希望runapi生成的接口跟手动新增的接口一样具备通知的功能;

star7th commented 7 months ago

我只能说后续会探讨下在runapi端引入像 网页版showdoc那种站内通知。 目前我看到的情况是使用率很低。因为， 站内通知是需要用户开着客户端才能看到。而用户不一定会看消息那么及时。这样很多人不怎么用，消息触达太慢了

baiyu5484556 commented 7 months ago

确实,网页版不像客户端,可以强制消息提醒,所以说集成第三方的消息通知功能还是很有意义的