【ApiDoc】如何使用JSON格式提交请求

本文详细介绍如何在ApiDoc中修改默认的表单提交方式为JSON提交,通过修改send_sample_request.js文件实现,使得用户可以使用表单界面提交JSON格式的数据,同时保持数据的清晰展示。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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也行啦

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

我的浪漫与极端

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值