接口文档的使用

article/2025/9/11 21:47:42

请求参数((GET方法就是Query参数,POST方法就是 Body参数)

  • 在 axios中通过headers选项设置Headers请求头参数

  • 在 axios中通过data选项设置Body请求体参数

  • 在 axios中通过params选项设置Query参数
    如果有 Query 参数,axios 会在内部把这个对象转为key=value&key=value 的数据格式,然后以?分割频道的url的后面传递给接口

axios({// Method请求方法method: 'post ',//常见的有GET(一般用于查询操作)、POST(一般用于添加)、PUT(一般用于修改,完整替换)、DELETE(一般用于删除操作)、PATCH(一般用于修改操作,局部修改),从使用角度不用关心为什么,因为这是后端设计的,我们决定不了。// PATH请求路径url: '请求路径",//请求路径中的:xXx表示路径参数//使用的时候需要指定参数,把数据值替换掉:xxxur1: '/mp/v1_0/articles /:target',ur1: ' /mp/v1_0/articles/1',ur1: '/mp/v1_0/articles/2',//在 axios 中通过headers选项设置请求头参数headers : {//名字:值//因为 axios 发送的请求默认会设置'Content-Type ' : 'application/json''Content-Type ' : 'application/json',Authorization:用户token},
// axios 中通过data选项设置Body请求体参数data:{mobile: '',code: ''},
// axios中通过params选项设置Query参数
// Query参数也叫查询参数
//如果有 Query参数,axios 会在内部把这个对象转为 key=value&key=value 的数据格式,然后以?分割频道的url的后面传递给接口params:{status: 2}
})
请求参数:
-请求头 Headers
-查询参数Query
-请求体Body
-路径参数

1.如何查看请求参数是否正确

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

1.1.请求头参数

在这里插入图片描述

1.2.请求体参数

在这里插入图片描述
现在chrome浏览器已经不在这个位置了
payload还有的,挪到跟headers平级了,在headers右边
在这里插入图片描述
在这里插入图片描述

2.遇到接口报错不要慌

  • 响应码,看接口文档中有没有说明该响应码的含义
    在这里插入图片描述

  • 先看响应结果,一般都有详细的错误日志
    在这里插入图片描述

  • 通过preview看响应结果更直观:
    在这里插入图片描述

  • 检查你的请求参数是否正确

    • 请求方法
    • 请求路径
    • 请求参数
      • Headers参数
      • Query参数(在url中)
      • Body参数
      • 路径参数(在url中)

http://chatgpt.dhexx.cn/article/bhcxwmeM.shtml

相关文章

接口文档包含哪些内容?怎么才能写好接口文档?十年测试老司机来告诉你

目录 接口文档结构 参数说明 示例 错误码说明 语言基调通俗易懂 及时更新与维护 总结 那么我们该如何写好一份优秀的接口文档呢? 接口文档结构 首先我们要知道文档结构是什么样子的。接口文档应该有清晰明确的结构,以便开发人员能快速定位自己需…

详解接口文档的编写

正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我总结下自己看到的优秀接口文档。 一、背景介绍 接口:API API(Application Programming Interface&…

如何写好API接口文档

日常项目开发的过程中,接口文档是必不可少的。后端工程师与前端工程师之间需要接口文档来定义数据传输协议、系统对外暴露接口需要文档来说明、系统之间相互调用需要文档来记录接口协议等等。对于一个完整的项目,接口文档是至关重要的。那我们如何写好一…

什么是接口文档

一、什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。 二、为…

如何正确规范写接口文档

前言 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。下面我将我看到的一篇接口文档做一个总结 开始吧!!! 接口1: 查询排重接口 接…

接口文档编写步骤与格式

接口文档编写步骤与格式 1. 基本步骤 梳理需求 依据业务写汉字版的接口文档。(可以减少在实际开发过程中的数据库调整) 写接口文档的过程中,会联想到需要上面样的数据。进而推出数据库设计。 数据库设计完毕。 正式的接口文档。 前端和后…

什么是接口文档,如何写接口,有什么规范?

一、什么是接口文档? 在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护。 二、为…

前后端接口文档编写

前后端分离需要编写接口文档,便于前后端工程师根据接口调用数据库和系统的功能。 接口分为四部分:方法、uri、请求参数、返回参数 1、方法:新增post、修改put、获取get、删除delete 2、uri:以"/"开头定义接口 3、请求参数和返回参…

怎么写接口文档

一些刚开始写接口文档的服务端同学,很容易按着代码的思路去编写接口文档,这让客户端同学或者是服务对接方技术人员经常吐槽,看不懂接口文档。这篇文章提供一个常规接口文档的编写方法,给大家参考。 推荐使用的是 http://docway.n…

圆环涂色问题

圆环涂色问题: 不考虑环形去序 本来我想的是第一个是m,后面是m-1,最后一个是m-2,但也可能倒数第二个和第一个是同色的,那么最后一个就可以是m-1了。所以全部取m-1,然后用上面的递推方法可以求得结果

关于环涂色问题的公式何其推导

问题描述:如下图,有M(m>2)个区域,如果给你n(n>3)种颜色,给这m个区域涂色, 要求相邻的区域颜色不能一样,问一共有几种涂法; 公式是:f(m)(-1)^m*(n-1)(n…

SCAU18730 涂色问题

思路:补集思想,快速幂 从正面想的话有点难度,从容斥定理的角度想了一会,发现重复的部分不会容斥。。。 我们从反面看,出现相邻相同数的方案总方案数-未出现相邻相同数的方案 总方案,每个位置有m种选择&a…

涂色问题

前言 一、处理策略 二、典例剖析 例1给一个各边不等的凸五边形的各边涂色,每边可以涂红、黄、蓝三种颜色中的一种,但是不允许相邻的边有相同的颜色,则不同的染色方法共有多少种? 分析:将凸五边形的各边依次编号为①②③…

日撸 Java 三百行(35 天: 涂色问题)

注意:这里是JAVA自学与了解的同步笔记与记录,如有问题欢迎指正说明 目录 一、关于涂色问题 二、代码实现思路 三、代码实现过程 1、初始化 2、核心代码(DFS部分) 3、染色合理性判断 四、数据模拟 总结 一、关于涂色问题 …

cnpm 安装yarn

cnpm 安装yarn 一句命令搞定 cnpm install -g yarn --registryhttps://registry.npm.taobao.org再配置下源 yarn config set registry https://registry.npm.taobao.org -gyarn config set sass_binary_site http://cdn.npm.taobao.org/dist/node-sass -g下面是官网提供的两…

npm和cnpm安装配置

在安装目录D:\programIntall\nodejs 新建node_global和node_cache 两个文件夹 npm config set prefix "D:\programIntall\nodejs\node_global"npm config set cache "D:\programIntall\nodejs\node_cache"在系统环境变量中添加NODE_PATH 在系统环境变量 P…

mac安装cnpm安装失败

参考了网上一篇博客 完成的安装。写下来纯属方便自己以后好找 也方便更多人看到。 官网安装node npm install -g cnpm --registryhttps://registry.npm.taobao.org 如果报一堆warn说明安装失败 依次输入 npm set registry https://registry.npm.taobao.org npm set dist…

git修改历史提交(commit)信息

我们在开发中使用git经常会遇到想要修改之前commit的提交信息,这里记录下怎么使用git修改之前已经提交的信息。一、修改最近一次commit的信息 首先通过git log查看commit信息。 我这里一共有6次commit记录。 最新的commit信息为“Merge branch ‘master’ of https:…

win7更改计算机属性,win7修改系统属性OEM信息的方法

win7修改系统属性OEM信息的方法分析给大家,我们都知道更改电脑属性里面OEM信息,让电脑更加个性化,OEM就是代工的意思,OEM版一般是Windows赋予合作伙伴在生产电脑是可以预装的系统。但是很多用户不知道如何修改OEM属性信息。本文系…

git 修改远端 commit 信息

git 修改远端 commit 信息 git rebase -i HEAD~x( x 代表最近几条commit ),执行之后将出现以下界面上面的 pick 后面即远端的 commit 信息,最下面的是最后的 commit修改指定 commit 的 pick 为 edit ,然后 wq 保存退出根据提示信息执行 git commit --am…