如何正确规范写接口文档

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

前言

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

开始吧!!!

接口1: 查询排重接口

接口详情
地址http://www.baidu.com (正式环境)
请求方式GET
参数是否必填说明
idfa广告标识符,只支持单个查询
source渠道来源,具体值在接入时再进行分配

返回结果格式JSON
状态码10000success(调用成功)
10001param error(参数错误)
10002query failed(查询失败)
10010access prohibited(访问拒绝)

具体返回结果举例:

1、查询成功

{"state": 10000,"message": "success","data": {"BD239708-2874-417C-8292-7E335A537FAD": 1 //已经存在}
}{"state": 10000,"message": "success","data": {"BD239708-2874-417C-8292-7E335A537FAD": 0 //不存在}
}
  1. 接口调用失败
{"state": 10010,"message": "access prohibited","data": []
}





如果满意,请打赏博主任意金额,感兴趣的请下方留言吧。可与博主自由讨论哦

支付包微信微信公众号
支付宝微信微信公众号

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

相关文章

接口文档编写步骤与格式

接口文档编写步骤与格式 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…

linux 更改cpu信息,奸商要疯狂,新软件任意修改英特尔CPU信息

昨日,网上出现一款名为“英特尔处理器信息更新”软件,支持任意修改英特尔CPU信息,例如内部型号和频率,支持写入到主板BIOS,无需更改注册表,这次,广大用户以后买新机器要注意,奸商们不…

Mysql数据库和数据表的创建和信息更改的常用指令

文章目录 数据库和数据表的创建和信息更改后续小实验做准备一. 关于数据库和数据表的其它操作1)数据库①创建数据库②显示目前所有的数据库③数据库重命名2.1 先创建新库:2.2 使用RENAME TABLE 命令修改表名,将表移动到新的库里:2…

如何修改PPT文档的原标题和作者信息

1.将鼠标放在PPT上可以看到原作者和标题的信息 2.右键PPT,选择属性 3.进入属性面板,点击详细信息选项卡,进入详细信息,可以看到作者和标题一栏。鼠标左键单击作者栏位或标题一栏,形成可编辑状态,直接修改…

win10计算机信息更改图,win10修改版本信息的简单方法【图文教程】

在某些特殊情况下,我们需要修改win10系统的版本信息,一般系统版本信息是本身就设置好的,能不能随意修改?大部分用户心理都没底,其实Win10系统版本号是可以任意修改,知识要掌握对的方法,如果你有…

web前端 | 博客(八)用户信息修改功能

用户信息修改功能 当点击用户后面的按钮时,要跳转到用户信息修改页面。而修改和添加实际上是同一个页面。 要区分跳转后是添加操作还是修改操作,在于携带的参数。 如果是添加操作,那就直接跳转过去;如果是修改操作,那…