开源文档工具 showdoc( www.showdoc.cc/help )推出调试接口的客户端(类似 postman ),支持 windows 和 mac 平台。开发者在调试接口的同时即可自动生成文档到 showdoc,简单好用易上手。 详情请看:www.showdoc.cc/runapi
此外,showdoc 是用 Vue + ElementUI 写的,而 runapi 主用 React + Ant Design,有技术方面的探讨也欢迎讨论。
1
shoaly 2020-06-24 10:03:10 +08:00
这个太完美了, 不爱写文档 又必须要写文档的人福音
|
2
raycloud 2020-06-24 10:15:23 +08:00 via Android
赞
|
3
wzq001 2020-06-24 10:34:34 +08:00
神器,赶紧试用下
|
4
star7th OP |
5
JRay 2020-06-24 11:07:01 +08:00
稳
|
6
balabalaguguji 2020-06-24 11:37:46 +08:00
易文档岂不是美滋滋,支持环境变量、前处理、后处理;还有 Mockserver,接口文档
https://easydoc.xyz ![QQ 截图 20200624113631.png]( https://i.loli.net/2020/06/24/xO1tbySfd2MjEci.png) |
7
wzq001 2020-06-24 11:44:52 +08:00
|
8
zpfhbyx 2020-06-24 12:13:07 +08:00
|
10
zpfhbyx 2020-06-24 12:29:20 +08:00
|
11
star7th OP @zpfhbyx 嗯,get 参数是要禁用 form 方式。其实你禁用不禁用对功能上没有影响,就是体验上要隐藏。
响应结果要分开 tab 才行,因为调试过程中可能有多次临时调试结果,不能直接作为文档。目前在切换 tab 这方面,有提供了小工具给用户一键复制过去,也能一键生成参数描述。不算很麻烦吧。 |
12
ipadpro4k 2020-06-24 13:14:53 +08:00 via iPhone
cc,xyz 域名的怎么敢用
|
13
star7th OP @ipadpro4k showdoc.cc 这个域名是四年前注册的,那时候是可备案的。现在新的 cc 域名就不可以备案了。我目前已经注册了 showdoc.top , .co .work 域名用来备份。com 域名的话,没办法,拿不到 showdoc 域名。
|
14
star7th OP @ipadpro4k 不放心使用线上服务的话自己使用开源版搭建吧 github.com/star7th/showdoc
|
15
deletemyself 2020-06-24 15:21:39 +08:00
试用建议:
1 、字段类型太少,建议自己填写或者给全选项 2 、最好有个同界面切换预览文档,现在还要复制链接到浏览器看 |
16
star7th OP @deletemyself 还有哪些字段类型没覆盖到的?预览文档这块的话,考虑下怎么做。
|
17
deletemyself 2020-06-24 15:46:28 +08:00
@star7th
1 、响应描述字段只有三个,比如常用的 array 没有 ![NdUKxI.png]( https://s1.ax1x.com/2020/06/24/NdUKxI.png) 2 、预览的话其实原来的 showdoc 文档编辑那种左右形式也可以,或者 tap 切换预览(感觉预览挺重要,特别是生成的文档只能看不能像原来那样直接编辑) |
18
star7th OP @deletemyself 其实 array 类型也算是 object 类型里面的。至少对 js 来讲,array 也是一种 object 。可能不同语言的定义有些许差别。预览功能可能是要看看想想。runapi 和 showdoc 使用的技术栈不一样,要共享预览样式不容易。同时,会不会用久了就习惯了,知道生成的都是一个模板都是那个样,就不需要预览了。这个得再收集下用户需求。
|