ApiDoc的URL默认是用表单方式进行提交数据
如果我们的接口入参是JSON类型的话,则要进行一些修改
其实网上已经有基本的介绍了,这里我把整个过程在封装的详细一点
但是restful接口基本是以json方式提交,但是json像swagger那样其实又不好看,又不直观,所以就想像apidoc这样既有表单形式的提交界面,又有最后自动封装成json的提交方式,嘻嘻~~
直接在安装目录下面找send_sample_request.js,然后直接上手改
将96行的ajax form表单的提交请求,替换成下面的这个:
// send AJAX request, catch success or error callback
$.ajax({
url: url,
dataType: "json",
contentType: "application/json",
data: JSON.stringify(param),
headers: header,
type: type.toUpperCase(),
success: displaySuccess,
error: displayError
});
当然我也是参考这位大佬的啦: ApiDoc json格式提交参数_一只大马猴的博客-优快云博客_apidoc json
然后我们就可以开开心心的用原来表单的界面提交json请求啦
当然如果想让其他组员一起看apidoc文档的话,直接把包含index.html的文件夹扔到http服务的某个路径下直接访问html路径就行,或者通过nginx也行啦