MySQL, Oracle, Linux, 软件架构及大数据技术知识分享平台

网站首页 > 精选文章 / 正文

如何做一个api接口?

2025-01-13 14:22 huorong 精选文章 4 ℃ 0 评论

因为我是做Java开发的,所以就按照Java的开发流程说一下;首先一个好的API接口,设计是要下功夫的,细节就不在这里说了,这里还是主要说实现;如果开发环境具备,前后大概也就不到十分钟,就可以完成一个简单的API接口的开发(只是个demo)。


0、开发前准备:电脑上需要安装JDK、Maven和IDE。

1、新建一个基于Spring Boot的项目,为了快速完成,我选择登录到【

start.spring.io

】网站上,生成一个项目。通过【Search dependencies to add】可以选择需要引入的包,我这里只引入了Web,也就是Spring MVC;假如你需要通过Mybatis访问数据库,也可以在这里选择;然后点击生成项目。

2、将下载好的项目,解压后引入到你的IDE中,新建一个类:

com.wukong.apidemo.controller

.ApiController

3、在这个类中增加一个方法,并主要使用@RestController、@RequestMapping、@ResponseBody两个标签,整个类大概是这个样子:

4、这时候最简单的一个API接口就完成了,我们可以启动项目后,访问对应的接口地址,得到接口的返回信息:

5、我们再对这个接口稍微加工一些,让swagger帮助我们生成一个接口文档:

5.1、在

pom.xml

中进入swagger需要的包:

5.2、对ApiController增加:@Api、@ApiOperation、@ApiImplicitParams等标签:

5.3、这时候启动项目后,访问:

http://10.141.48.41:8080/swagger-ui.html

5.4、这里留了一个小问题,swagger的配置少了一步,按照上面的做饭,访问swagger的页面是会报404的,大家可以尝试解决。

我将持续分享Java开发、架构设计、程序员职业发展等方面的见解,希望能得到你的关注。

Tags:@apioperation

控制面板
您好,欢迎到访网站!
  查看权限
网站分类
最新留言