idea swagger生成接口文档_Springboot结合swagger-ui自动生成接口文档

本文介绍了如何使用SpringBoot结合swagger-ui快速生成接口文档,从创建SpringBoot项目,添加相关依赖,到配置文件设置,再到创建controller类,最后运行程序并访问swagger-ui页面。通过图文并茂的方式,详细解释了每个步骤,适合初学者参考。
摘要由CSDN通过智能技术生成

前阵子偶然接触到一个小框架,立马被深深吸引,然后研究一阵子后,今天有时间了,可以在这里给总结一下,算是一个小结,也是自己学习的一个记录。

记得一年前,初次接触API开发文档时,那时候是一遍写代码,一边写文档或者是代码写完后,然后再回过头来写开发文档,相信不少人都有这样的经验。

前阵子接触到swagger-ui,马上被它的便捷性锁吸引,下图是工作中代码生成的API,涉及到公司业务的,已打码。

下面,创建一个小Demo,使用SpringBoot整合一下swagger-ui这个框架,算是对自己学习的一个补充,也算是一份基础入门教程,希望可以帮助到有需要的朋友~目前感觉这个框架在国内还不是特别火的样子~

第一步:创建一个SpringBoot项目,然后加入相关依赖,下面是我的pom.xml文件:

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

cn.jiayao

demo

0.0.1-SNAPSHOT

war

demo

Demo project for Spring Boot

org.springframework.boot

spring-boot-starter-parent

1.5.10.RELEASE

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值