java怎么写接口,java开发api接口教程

简介: java怎么写接口,java开发api接口教程

在大家的工作中,经常写界面。 而且,最常用的是http接口。 但是,对于初学者Java工作人员来说,写http界面还很难。 那么,用实例来说明吧。


一、建设项目


首先,生成SpringBoot项目。 省略如何构建此处,并引入相关依赖关系:


org.springframework.boot


artifactIdspring-boot-starter


/从属


从属关系


org.projectlombok


artifactIdlombok


可选真


/从属


从属关系


org.springframework.boot


artifactidspring-boot-starter-test


scopetest


/从属


从属关系


org.spring帧work.boot


artifactidspring-boot-starter-web


/从属


二.写共同的结果对象


一个接口的返回信息必须至少包含以下内容:


1、结果代码


2、结果信息


3、返回数据


因此,创建一个新类来记录返回的结果集Result :@Data


@AllArgsConstructor


@NoArgsConstructor


公共类结果


{


私密int代码;


隐私消息;


私有对象数据;


}


其中,结果代码和结果信息需要统一,这里枚举类型最优,新建枚举类responsecodepublicenumresponsecode


{


//系统模块


success(0,“操作成功”


、错误(1、“操作失败”) ) )。


、server_error(500、“服务器异常”)、


//通用模块1xxxx


illegal_argument(10000,参数无效


、repetitive_operation((10001,'不要重复操作') ) ) )。


、access_limit(10002,“请求频繁。 请稍后再试"


、mail_send_success(10003、“邮件发送成功”)、


//用户模块2xxxx


NEED_login(20001,“已禁用登录”() ) ) ) ) ) ) ) ) )。


、username _ or _ password _ empty (20002,'用户名或密码不能为空') ) ) ) )。


、username _ or _ password _ wrong (20003,“用户名或密码错误”


、user_not_exists(20004,'用户不存在') ) ) )。


、Wrong_password(20005,“密码错误”


响应代码(integer代码,字符串msg ) )。


{


this.code=代码;


this.msg=msg;


}


隐私保护代码;


隐私保护msg;


publicIntegergetCode (


{


返回代码;


}


publicvoidsetcode (集成代码) )。


{


this.code=代码;


}


公共字符串getmsg (


{


returnmsg;


}


公共语音(字符串msg )。


{


this.msg=msg;


}


}


三.界面创建


上面的两个类可以用作其他项目的公共类。 写接口的时候直接输入代码就可以了。 接下来,写一个界面,测试一下:


新建响应控制器@ rest控制器


publicclassResponseController


{


@ request mapping (value='/get data ',method=RequestMethod.GET ) )。


publicResultgetData (


{


Mapmap=newHashMap (;


map.put('name )、' javayz );


map.put(age,) 23 );


MapchildMap=newHashMap (;


childmap.put(home,)浙江;


childmap.put(job,java );


map.put('childMap ',childmap );


result result=new result (response code.success.getcode )、ResponseCode.SUCCESS.getMsg )、map );


返回结果;


}


}


此示例说明如何从Map集合插入数据,然后最后返回到Result。 调用结果如下。 {


'代码' :0


、“消息' : '操作成功”


、' data':


{


' name':'javayz '


,' childMap':


{


' job':'java '


,' home': '浙江'


}


,' age':'23 '


}


}


除了使用Map传递数据外,还可以通过对象传递数据。 新的两个类是用户和用户详细信息。 @data


@AllArgsConstructor


@NoArgsConstructor


公共类用户


{


隐私名称;


隐私保护代理;


隐私用户数据中心;


}@Data


@AllArgsConstructor


@NoArgsConstructor


publicclassUserDetail


{


私有家庭;


隐私任务;


}


为Get请求创建新接口,并在界面中以对象传递数据@ request mapping (value='/get data2',method=RequestMethod.GET )


publicResultgetData2(


{


userdetailuserdetail=new user detail ('浙江',' java ' );


useruser=newuser('Javayz ',' 23 ',userDetail;


result result=new result (response code.success.getcode )、ResponseCode.SUCCESS.getMsg )、user );


返回结果;


}


调用接口时,返回值如下所示。 {


'代码' :0


、“消息' : '操作成功”


、' data':


{


' name':'javayz '


,' age':'23 '


,'用户详细信息' :


{


'家庭' : '浙江'


,' job':'java '


}


}


}


到目前为止,我们已经共享了java如何编写http接口。 从项目的构建到界面的创建都写得很详细。 大家只要能多次操作就习惯了。 最后,如果想了解更多关于java实例的知识,


相关文章
|
8月前
|
缓存 监控 前端开发
顺企网 API 开发实战:搜索 / 详情接口从 0 到 1 落地(附 Elasticsearch 优化 + 错误速查)
企业API开发常陷参数、缓存、错误处理三大坑?本指南拆解顺企网双接口全流程,涵盖搜索优化、签名验证、限流应对,附可复用代码与错误速查表,助你2小时高效搞定开发,提升响应速度与稳定性。
|
8月前
|
JSON 算法 API
Python采集淘宝商品评论API接口及JSON数据返回全程指南
Python采集淘宝商品评论API接口及JSON数据返回全程指南
|
8月前
|
JSON API 数据安全/隐私保护
Python采集淘宝拍立淘按图搜索API接口及JSON数据返回全流程指南
通过以上流程,可实现淘宝拍立淘按图搜索的完整调用链路,并获取结构化的JSON商品数据,支撑电商比价、智能推荐等业务场景。
|
8月前
|
Java Go 开发工具
【Java】(9)抽象类、接口、内部的运用与作用分析,枚举类型的使用
抽象类必须使用abstract修饰符来修饰,抽象方法也必须使用abstract修饰符来修饰,抽象方法不能有方法体。抽象类不能被实例化,无法使用new关键字来调用抽象类的构造器创建抽象类的实例。抽象类可以包含成员变量、方法(普通方法和抽象方法都可以)、构造器、初始化块、内部类(接 口、枚举)5种成分。抽象类的构造器不能用于创建实例,主要是用于被其子类调用。抽象类中不一定包含抽象方法,但是有抽象方法的类必定是抽象类abstract static不能同时修饰一个方法。
329 1
|
8月前
|
人工智能 自然语言处理 测试技术
Apipost智能搜索:只需用业务语言描述需求,就能精准定位目标接口,API 搜索的下一代形态!
在大型项目中,API 数量庞大、命名不一,导致“找接口”耗时费力。传统工具依赖关键词搜索,难以应对语义模糊或命名不规范的场景。Apipost AI 智能搜索功能,支持自然语言查询,如“和用户登录有关的接口”,系统可理解语义并精准匹配目标接口。无论是新人上手、模糊查找还是批量定位,都能大幅提升检索效率,降低协作成本。从关键词到语义理解,智能搜索让开发者少花时间找接口,多专注核心开发,真正实现高效协作。
|
8月前
|
存储 缓存 算法
亚马逊 SP-API 深度开发:关键字搜索接口的购物意图挖掘与合规竞品分析
本文深度解析亚马逊SP-API关键字搜索接口的合规调用与商业应用,涵盖意图识别、竞品分析、性能优化全链路。通过COSMO算法解析用户购物意图,结合合规技术方案提升关键词转化率,助力卖家实现数据驱动决策,安全高效优化运营。
|
8月前
|
Oracle Java 关系型数据库
Java 简单教程
Java是跨平台、面向对象的编程语言,广泛用于企业开发、Android应用等。本教程涵盖环境搭建、基础语法、流程控制、面向对象、集合与异常处理,助你快速入门并编写简单程序,为进一步深入学习打下坚实基础。
573 0
|
Java 开发工具 git
Java开发初级6.24.3
5.在Git使用过程中,进行Git配置的操作命令是哪个() A. config B. config -g C. config -a D. git config 相关知识点: 在git中,经常使用git config 命令用来配置git的配置文件,git配置级别主要有:仓库级别 local 【优先级最高】、用户级别 global【优先级次之】、系统级别 system【优先级最低】 正确答案:D 10.RDBMS是什么? A. Rela Database Management Systems B. Relational Database Management Systems C. Relation
286 0
|
SQL 前端开发 JavaScript
Java开发初级6.24.2
3.Java网站src/main/java目录保存的是什么资源? A. Java源代码文件 B. 测试代码 C. JavaScript、CSS等文件 D. 图片资源 正确答案:A 4.什么是索引Index? A. SQL数据库里的表管理工具 B. SQL数据库里的查询工具 C. SQL数据库里的目录工具 D. SQL数据库用来加速数据查询的特殊的数据结构 正确答案:D
347 0
|
Java
Java开发初级6.24.1
1.下面关于泛型的描述中错误的一项是? A. “? extends 类”表示设置泛型上限 B. “? super 类”表示设置泛型下限 C. 利用“?”通配符可以接收全部的泛型类型实例,但却不可修改泛型属性内容 D. 如果类在定义时使用了泛型,则在实例化类对象时需要设置相应的泛型类型,否则程序将无法编译通过 相关知识点: https://edu.aliyun.com/course/35 正确答案:D 2.下列选项中属于SVN中控制鉴权用户访问版本库的权限默认权限的是() A. write B. read C. none D. null 相关知识点: auth-access:取值范围为"writ
390 0

热门文章

最新文章