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实例的知识,


目录
打赏
0
0
0
0
114
分享
相关文章
|
1天前
|
解析电商商品详情API接口系列,json数据示例参考
电商商品详情API接口是电商平台的重要组成部分,提供了商品的详细信息,支持用户进行商品浏览和购买决策。通过合理的API设计和优化,可以提升系统性能和用户体验。希望本文的解析和示例能够为开发者提供参考,帮助构建高效、可靠的电商系统。
20 12
【潜意识Java】javaee中的SpringBoot在Java 开发中的应用与详细分析
本文介绍了 Spring Boot 的核心概念和使用场景,并通过一个实战项目演示了如何构建一个简单的 RESTful API。
19 5
探究Java异常处理【保姆级教程】
Java 异常处理是确保程序稳健运行的关键机制。它通过捕获和处理运行时错误,避免程序崩溃。Java 的异常体系以 `Throwable` 为基础,分为 `Error` 和 `Exception`。前者表示严重错误,后者可细分为受检和非受检异常。常见的异常处理方式包括 `try-catch-finally`、`throws` 和 `throw` 关键字。此外,还可以自定义异常类以满足特定需求。最佳实践包括捕获具体异常、合理使用 `finally` 块和谨慎抛出异常。掌握这些技巧能显著提升程序的健壮性和可靠性。
15 4
Java后端开发-使用springboot进行Mybatis连接数据库步骤
本文介绍了使用Java和IDEA进行数据库操作的详细步骤,涵盖从数据库准备到测试类编写及运行的全过程。主要内容包括: 1. **数据库准备**:创建数据库和表。 2. **查询数据库**:验证数据库是否可用。 3. **IDEA代码配置**:构建实体类并配置数据库连接。 4. **测试类编写**:编写并运行测试类以确保一切正常。
10 2
【潜意识Java】Java基础教程:从零开始的学习之旅
本文介绍了 Java 编程语言的基础知识,涵盖从简介、程序结构到面向对象编程的核心概念。首先,Java 是一种高级、跨平台的面向对象语言,支持“一次编写,到处运行”。接着,文章详细讲解了 Java 程序的基本结构,包括包声明、导入语句、类声明和 main 方法。随后,深入探讨了基础语法,如数据类型、变量、控制结构、方法和数组。此外,还介绍了面向对象编程的关键概念,例如类与对象、继承和多态。最后,针对常见的编程错误提供了调试技巧,并总结了学习 Java 的重要性和方法。适合初学者逐步掌握 Java 编程。
10 1
Git使用教程-将idea本地Java等文件配置到gitte上【保姆级教程】
本内容详细介绍了使用Git进行版本控制的全过程,涵盖从本地仓库创建到远程仓库配置,以及最终推送代码至远程仓库的步骤。
11 0
初学者不会写接口怎么办?微软Visual Studio 2022无脑式API接口创建——Swagger一键导入APIKit快速测试
初学者不会写接口怎么办?微软Visual Studio 2022无脑式API接口创建——Swagger一键导入APIKit快速测试
427 0

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等