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

这篇具有很好参考价值的文章主要介绍了java怎么写接口,java开发api接口教程。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

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

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

一、建设项目

首先,生成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实例的知识,请​​前往了解​​

 文章来源地址https://www.toymoban.com/news/detail-451933.html

到了这里,关于java怎么写接口,java开发api接口教程的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 今天教大家微信小程序怎么免300元认证费终身使用的教程

    众所周知微信小程序认证需要300元认证费,当然用已认证的微信公众号可以免费认证但是认证微信公众号也需要300认证费而且需要每年进行年检等于每年都要花300元。 不知道大家注册小程序的时候有没有发现审核很慢申请完需要等几天很费时间, 而且微信限制一个身份证只

    2024年02月08日
    浏览(58)
  • 查询法定工作日的API接口

      在现代社会中,时间的规划和安排对于个人和企业来说非常重要。在我们处理时间上的事务时,我们需要知道某一天是否是国家法定节假日或者法定工作日。因此,开发一个能够查询特定日期的法定工作日的API接口就变得非常有必要了。 一、功能说明 该API接口的主要功能

    2024年01月20日
    浏览(39)
  • AIGC: 关于ChatGPT中API接口调用相关准备工作

    ChatGPT之API接口相关 通过页面和GPT交流获取信息相比直接调用GPT的API而言是非常有限的 页面上的GPT是比较封闭的,而且只允许我们去输入文本的信息 我们需要借助GPT的API开发来激发AI工具的无限可能,实现更多个性化需求 1 ) 使用API 使用API有一个前置的条件 注册ChatGPT账号

    2024年02月04日
    浏览(53)
  • Elasticsearch教程—Elasticsearch Java API Client [8.6]开发入门(官方原版)

    大家好,我是Doker! Java 8 或更高版本。 一个 JSON 对象映射库,允许无缝集成 您的应用程序类与 Elasticsearch API 一起。Java 客户端具有 支持 Jackson 或 Eclipse Yasson 等 JSON-B 库。 Java API客户端由三个主要组件组成: API客户端类。这些为Elasticsearch API提供了强类型的数据结构和方法。

    2024年02月13日
    浏览(37)
  • 怎么调用api接口

    1 .API接口是一种通信协议,用于不同的应用程序之间的数据交换。要编写API接口,需要遵循以下步骤: 确定API的用途和功能。 设计API接口,并确定所有输入和输出参数。 编写API代码,包括数据验证、逻辑处理和错误处理。 将API暴露给外部应用程序,通常是通过RESTful或SOAP协

    2024年02月07日
    浏览(50)
  • api应该怎么用?(简单方便的API接口方法)

    1.API简单来说就是接口。windows API是windows操作系统开发的接口,用于控制系统中的各种应用程序。 2.在哪里可以找到API?VB6.0自带WindowsAPI的搜索工具,可以根据搜索到的接口自动生成声明语句。在Windows开始菜单栏找到api浏览器,打开api浏览器——然后导入win 32 API . txt——搜索我们

    2024年02月15日
    浏览(43)
  • 【API接口工具】postman-Workspaces工作空间 VS Scratch Pad草稿面板

    Scratch Pad是一个可以在未连接到 Postman 服务器的情况下工作的空间。当您未登录或没有网络连接时,您仍然可以离线访问某些 Postman 功能,例如创建集合和请求,或发送请求。 Scratch Pad 中的所有工作都存储在本地,不会与 Postman 在线同步。在便笺簿中工作后,您可以稍后在登

    2023年04月10日
    浏览(31)
  • 工作中,我们经常用到哪些SQL语句呢?

    目录 一、DDL部分(create、drop、alter) 1.1 create 语句上 1.2 drop 语句 1.3 alter 语句 二、DML(数据操纵语言)和DQL(数据查询语言) 2.1 insert 语句 2.2 update 语句 2.3 delete 语句 2.4 select 语句 2.5 其他操纵语言 2.5.1 truncate 语句 2.5.2 merge 语句 三、用户角色权限 3.1 用户相关 3.1.1 创建用户

    2024年02月03日
    浏览(47)
  • api接口怎么对接?你只需要注意这4点

    原则上API接口设计一般出现在开发的详细设计中,但是随着诸多公司建立开放平台,产品经理也逐渐需要能理解API接口,尤其是做平台性的产品,还要学会定义接口。本文就关于产品经理在设计接口中需要定义什么、需要注意什么来展开陈述。 一、了解API的常识 在做接口设

    2024年02月04日
    浏览(51)
  • 关于怎么用好API接口获取更多信息节约时间成本

      API接口是现代互联网应用开发的重要工具,它允许开发者使用标准化的方式获取数据和服务,在搭建应用中扮演了重要的角色。因此,如何利用API接口获取更多信息已经成为了每个开发者需要掌握的技能之一。 第一步:寻找 API接口 在开始使用API接口前,首先要确定需要获

    2024年02月06日
    浏览(61)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包