多语言展示
当前在线:369今日阅读:168今日分享:49

swagger让你远离手写api文档的烦恼

java服务器接口开发的程序员都知道与移动端打交道最重要的就是API调用文档,然而文档写起来可能是大多数coder头疼的事情。今天介绍的就是一款很棒的工具swagger,它可以通过注解的方式,让你远离手写文档的烦恼
工具/原料
1

开发工具idea

2

对springboot有一定了解

3

最重要的你是一个JAVA开发人员

方法/步骤
1

1、通过spring网站进行springboot项目生成,解压生成的文件,修改pom.xml,然后添加swagger的maven依赖

2

2、用IDE编辑器IDEA打开,添加swagger相关java类进行配置,找到DemoApplication添加@Controller并添加接口方法,然后直接debug运行DemoApplication

3

3、浏览器上访问http://本机ip:8080/swagger-ui.html,修改接口访问方法,并添加请求参数,在重启程序后,查看接口文档的变化

4

4、到这里就完成了springboot接入swagger的操作,swagger其他注解的用法,如何自定义返回的swagger的接口文档信息,如何使用swagger注解来简化代码业务执行逻辑等等。后续继续发表相关的文章,如果读者有什么问题请留言

注意事项

注意看截图,截图上非常详细

推荐信息