IT辅导娱乐网| 蜘蛛地图| 所有文章|
springboot集成swagger详解 - IT辅导
  • 首页
  • IT技术 IT辅导资源网设计图
    • DVWA靶场
    • sqli-lab靶场
  • 源码基地
  • 软件分享 IT辅导资源网设计图
    • 辅助软件
  • emlog教程
  • 白嫖活动
  • 网络技巧 IT辅导资源网设计图
    • seo教程
  • 编程教程
  • 值得看一看 IT辅导资源网设计图
    • 值得听一听
    • 读懂世界
    • 活动线报
  • 更多功能 IT辅导资源网设计图
    • 在线投稿
    • 公告动态
    • 广告合作
    • 匿名投稿


登录后,享受更多优质服务哦
IT辅导资源网站长qq头像
欢迎回来,可爱的会员!个人中心退出登录
导航菜单
  • 首页
  • IT技术
    • DVWA靶场
    • sqli-lab靶场
  • 源码基地
  • 软件分享
    • 辅助软件
  • emlog教程
  • 白嫖活动
  • 网络技巧
    • seo教程
  • 编程教程
  • 值得看一看
    • 值得听一听
    • 读懂世界
    • 活动线报
  • 更多功能
    • 在线投稿
    • 公告动态
    • 广告合作
    • 匿名投稿

springboot集成swagger详解

2020/9/2 五年级扛把子 

前言

    Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务,而受开发者的欢迎。随着微服务的兴起,springboot集成swagger对于Java开发者是必须要掌握的,下面就来学习一下springboot集成swagger的步骤吧。

springboot集成swagger步骤

    第一步:maven导入Swagger如下:

    

 <!-- 添加使用swagger的依赖包 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.2.2</version>
</dependency>
<!-- 添加使用swagger的依赖包 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.2.2</version>
</dependency>

第二步:创建Swagger2配置类,如下所示:

/**
*
*/
package swagger.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
* @author ignore1992
*
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig
{
@Bean
public Docket createDocket()
{
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(createApiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("swagger.api.controller"))
.paths(PathSelectors.any())
.build();
}

private ApiInfo createApiInfo()
{
return new ApiInfoBuilder()
.title("springboot使用swagger2")
.description("生成对应接口文档")
.termsOfServiceUrl("https://blog.csdn.net/ignorewho")
.contact("ignore1992")
.version("1.0")
.build();
}
}

第三步:这样就可以使用swagger提供的注解,来完成描述,调用,生成等功能

常用注解如下:

@Api : 用在类上,说明该类的主要作用。

@ApiOperation:用在方法上,给API增加方法说明。

@ApiImplicitParams : 用在方法上,包含一组参数说明。

@ApiImplicitParam:用来注解来给方法入参增加说明。

使用案例如下:
/**
*
*/
package swagger.api.controller;

import io.swagger.annotations.ApiOperation;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

/**
* @author ignore1992
*
*/
@RestController
@RequestMapping(value = "/swaggerapi")
public class SwaggerApiController
{
@ApiOperation(value = "测试swaggerapi接口方法")
@RequestMapping(value = "/test", method = RequestMethod.GET)
public String test()throws Exception
{
return "swaggerapi 测试";
}
}

总结

    以上就是本文关于对springboot集成swagger的全部内容,希望对大家有所帮助。有什么问题可以随时留言,期待您的宝贵意见!  

 点赞:0  打赏  分享  海报

  • 打赏支付宝扫一扫
  • 打赏微信扫一扫
  • 打赏企鹅扫一扫
结束语
温馨提醒:如有技术问题以及资源失效请联系站长 QQ89549822 进行反馈!!!
 您阅读本文耗时: 0小时02分35秒
热度:344° 发布时间:2020年9月2日

推荐:

标题:springboot集成swagger详解

链接: https://www.itfd.cn/post-1201.html

版权:转载请注明来源于【IT辅导娱乐网】为原创

上一篇: Java中Error和Exception的区别简介

下一篇: Hibernate中5个核心接口介绍

作者头像 作者名称 作者性别
五年级扛把子
联系作者 作者主页

热门推荐

1 Java工程师常见spring面试题锦集
2 Java面向对象的概念以及面向对象的特征
3 Java jdk下载与安装,超级详细
4 常用排序算法与Java实现
5 Java生成随机数的方法介绍
6 it,新(活跃)神仙姐姐23388945

评论列表

取消回复

  • 存档

    • 2020年9月(191)
    • 2020年8月(92)
    • 2020年7月(5)
    • 2020年6月(224)
    • 2020年5月(392)
    • 2020年4月(267)
    • 2020年3月(76)
    • 2019年3月(1)
    • 1970年1月(29)
  • 搜索

  • 热门文章

    • 神佑之路手游源码-附视频教程
    • 最新可用老王VPN2.22.15谷歌市场版,免费使用
    • 私藏的十个网站,不看后悔系列
    • 虚拟商品自动发货商城源码
    • 不吃苦、不奋斗,你要青春做什么?
  • 随机文章

      • java遍历文件夹下所有文件示例
        • Java Map集合遍历
          • javaWeb开发ssm框架搭建步骤详解
            • IDEA通过maven构建JavaWeb项目步骤详解
              • java中Calendar类的使用讲解
    提示信息

    SQL语句执行错误: SELECT COUNT(*) AS total FROM emlog_twitter
    Table 'itfd.emlog_twitter' doesn't exist

    «点击返回