showdoc icon indicating copy to clipboard operation
showdoc copied to clipboard

能否增加下接口http://xx.com/server/index.php?s=/api/item/updateByApi的参数说明

Open chen-45 opened this issue 2 years ago • 6 comments

目前项目想自动化生成runapi模式的文档,普通showdoc文档不能调试,但是updateByApi没有针对pageContent做一下描述 只定义了类型为string 通过 https://github.com/whaios/goshowdoc 这个仓库的代码得知了pageContent的结构 希望作者能给个正式的介绍

chen-45 avatar Mar 09 '23 07:03 chen-45

如果要生成runapi可调试的文档,则可以利用程序注释生成。https://www.showdoc.com.cn/page/741656402509783 如果你想自由生成,则可以自己写程序生成单独的注释文件放在子目录下,然后再启动脚本从注释中生成。

star7th avatar Mar 09 '23 07:03 star7th

这个方式测试过 只能生成markdown格式的文档 无法在runapi客户端运行调试 。updateByApi这个接口生成的文档可以运行调试

image image

chen-45 avatar Mar 09 '23 07:03 chen-45

你先确定把showdoc服务端升级到最新版。我应该是半年前才支持 通过注释生成的runapi文档 可调试。

star7th avatar Mar 09 '23 07:03 star7th

原来是版本问题 感谢 目前可能不会更新 我觉得 updateByApi 更新的内容很齐全 很好用 就是文档少了对pageContent字段的描述或者一个详细示例 有时间还是希望您能更新下

chen-45 avatar Mar 09 '23 07:03 chen-45

我不会更新pageContent字段的描述,以免增加维护成本。历史原因,pageContent字段的组成比较复杂,写起来麻烦。写出来后,以后维护更新也是一个麻烦,,并且因为我以后可能会修改。现在是全部都放在pageContent字段里,以后也讲不定我会结构化把存储在数据库。写这个文档就是给我自己找维护麻烦。

star7th avatar Mar 09 '23 07:03 star7th

有需要的话自己抓包分析,但是我不提供官方支持。我的支持就是上面说的,更新到新版,然后用官方脚本方案。非官方方案,我不会去支持。

star7th avatar Mar 09 '23 07:03 star7th