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




















，请​​前往了解​​