如何根据接口文档,写一个接口类(举例说明)

article/2025/9/11 21:46:53

直接先贴图(文中的url做了修改):

代码如下:

@FeignClient(name = "Z_KPI_API",url = "${Z.KPI.url:http://11.11.111.111:8080}",fallback = ZApiClientFallback.class)
public Interface ZApiClient{@PostMapping(path = "a/b",produces = "application/json")ZQueryResult query( @RequestParam("hostName")String hostName,@RequestParam(name = "hostType",defaultValue = "ne")String hostType,@RequestParam("fromTime")String fromTime,@RequestParam("endTime")String endTime,@RequestParam(name = "cpllectType",defaultValue = "Zabbix")String collectType,@RequestParam(name = "history",required = false)Integer history); }

通过接口文档,需要弄清楚下面几条信息:

1、确定请求方式——post

2、拿到URL:http://11.11.111.111:8080

3、接口的路径:/a/b

4、请求参数

hostName,hostType,fromTime,endTime,collectType,history

5、返回形式:JSON

6、并且需要知道,返回值表示的意思

 

技术总结:

1、@FeignClient

本次例子,用到的参数是name,url,fallback

2、@RequestParam

本次例子,用到的参数是name,required

可以通过required=false或者true来要求@RequestParam配置的前端参数是否一定要传 ,此处history不一定要传。不传的话会给参数赋值为null。

注意:GET和POST请求传的参数会自动转换赋值到@RequestParam 所注解的变量上

3、@PostMapping

本次例子,用到的参数是path,produces

关于PostMapping和GetMapping有

https://blog.csdn.net/linjpg/article/details/76927075

 

 

 

 


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

相关文章

Postman写接口文档

文章目录 参考首先了解什么是postman那么后端如何用postman编写接口文档,并且让前端或者其他开发人员也一起同步协作呢?1. 注册登录postman2. 创建项目工作区3. 编写接口文档4. 添加协作人(这一步也可以在创建工作区之初就操作)5.…

怎么写一份好的接口文档?

编写一份优秀的接口文档会让软件开发中变得更加轻松,更有效率。这可是关键任务,写得好不仅可以帮助开发人员更好地理解和使用 API 接口,还可以提高整个团队的协作效率。 大家可以在线感受一下优秀的接口文档是怎样的:https://pets…

接口文档的使用

请求参数((GET方法就是Query参数,POST方法就是 Body参数) 在 axios中通过headers选项设置Headers请求头参数 在 axios中通过data选项设置Body请求体参数 在 axios中通过params选项设置Query参数 如果有 Query 参数,axios 会在内部把这个对象…

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

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

详解接口文档的编写

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