ApiDoc json格式提交参数

我们默认安装的apidoc,提供了在线测试接口的功能,但是默认的参数提交是form表单提交,而我们编写的接口通常是restful的接口,一般都是采用json格式的数据提交,那我们怎么把默认的参数格式修改为我们想要的json提交方式呢?

 

操作很简单:

找到apidoc模版send_sample_request.js

我的安装路径是在:C:\Users\TK-2018\AppData\Roaming\npm\node_modules\apidoc\template\utils目录下,

看官们根据自己的实际路径去寻找吧

 

关键的一步来了:

编辑这个模版,将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的格式测试接口啦、

### BladeX 代码生成配置教程 BladeX 提供了一套完整的代码生成功能,允许开发者通过简单的配置来自动生成所需的业务代码。这不仅提高了开发效率,还减少了人为错误的发生。 #### 配置环境准备 为了能够顺利使用 BladeX 的代码生成功能,首先需要确保已经安装并正确配置了 BladeX 开发环境[^1]。通常情况下,在完成基础环境搭建之后,可以通过前端研发工具中的“代码生成配置”选项来启动代码生成向导。 #### 创建新的代码生成方案 进入 **前端研发工具 -> 代码生成配置** 页面后,可以点击【新建】按钮创建一个新的代码生成方案。在此过程中,需指定目标服务以及相应的路径信息。对于大多数情况而言,只需提供项目根路径即可自动识别其他必要参数[^2]。 ```json { "serviceName": "blade-swagger", "basePath": "/path/to/your/project" } ``` #### 设置API文档自动生成 如果希望同步生成 API 文档,则可以在上述 JSON 结构基础上增加 `apidoc` 字段,并指明源码所在目录 (`-i`) 及输出位置 (`-o`) 。例如: ```json { "serviceName": "blade-swagger", "basePath": "/path/to/your/project", "apidoc": { "-i": "./src/api", "-o": "./public/apidoc" } } ``` 此操作将会在执行代码生成的同时构建一份详细的 RESTful 接口说明文档,方便前后端团队协作交流[^3]。 #### 执行代码生成过程 当所有的准备工作都已完成以后,就可以提交表单触发实际的代码生成流程了。整个过程由后台服务器处理完毕后,会在指定的位置找到新产生的文件资源。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值