[idea] SpringBoot整合swagger2实现CRUD

一:创建SpringBoot ,在pom.xml文件中加入jar包

  

<dependency>    <groupId>io.springfox</groupId>    <artifactId>springfox-swagger2</artifactId>    <version>2.8.0</version></dependency><dependency>    <groupId>io.springfox</groupId>    <artifactId>springfox-swagger-ui</artifactId>    <version>2.8.0</version></dependency>

二:简历Swagger2的配置类  
@EnableSwagger2    //注入swagger2@Configuration     //beanspublic class SwaggerConfig {    @Bean      //bean    public Docket createRestApi(){        return new Docket(DocumentationType.SWAGGER_2)                .groupName("apigrounp1")                .apiInfo(apiInfo())//组名                .select()//选择那些路劲和api生成document                .apis(RequestHandlerSelectors.basePackage("com.hp.springbootswagger.controller"))                .paths(PathSelectors.any())//对所有路劲渐行监控                .build();    }    //构建api文档的详细信息方法    public ApiInfo apiInfo(){        return new ApiInfoBuilder()                .title("Spring boot测试使用Swagger2构建RestFulApi")//页面标题                .contact(new Contact("浩明","https://www.baidu.com","1343876119@qq.com"))//创建人                .version("1.0")//版本号                .description("API描述")//api描述                .build();//构建    }}

三:controller层:result风格  
@Api(value="person" ,description="针对用户的插入,删除,查看等操作")类上面:
@ApiOperation(value ="创建用户",notes = "根据用户User创建用户")@ApiImplicitParams({        @ApiImplicitParam(dataType = "java.long.Lang",paramType = "path",name = "id",value = "id",required = true),        @ApiImplicitParam(dataType = "User",name = "user",value = "用户",required = true)})方法上:

四:swagger2的相关注解的解释如下:
  
  • @Api:修饰整个类,描述Controller的作用
  • @ApiOperation:描述一个类的一个方法,或者说一个接口
  • @ApiParam:单个参数描述
  • @ApiModel:用对象来接收参数
  • @ApiProperty:用对象接收参数时,描述对象的一个字段
  • @ApiResponse:HTTP响应其中1个描述
  • @ApiResponses:HTTP响应整体描述
  • @ApiIgnore:使用该注解忽略这个API
  • @ApiError :发生错误返回的信息
  • @ApiImplicitParam:一个请求参数
  • @ApiImplicitParams:多个请求参数
swagger-ui页面请求:http://localhost:8080/swagger-ui.html

原文地址:https://www.cnblogs.com/yhm9/p/10513624.html

时间: 2024-10-30 19:43:45

[idea] SpringBoot整合swagger2实现CRUD的相关文章

5分钟 springboot 整合swagger2

springboot 整合swagger2 1.maven配置文件中添加依赖 <properties> <swagger2.version>2.2.2</swagger2.version> </properties> -------------------------------------------------- <dependency> <groupId>io.springfox</groupId> <arti

SpringBoot整合Swagger2

手写Api文档的几个痛点: 文档需要更新的时候,需要再次发送一份给前端,也就是文档更新交流不及时. 接口返回结果不明确 不能直接在线测试接口,通常需要使用工具,比如postman 接口文档太多,不好管理 Swagger也就是为了解决这个问题,当然也不能说Swagger就一定是完美的,当然也有缺点,最明显的就是代码移入性比较强. 其他的不多说,想要了解Swagger的,可以去Swagger官网,可以直接使用Swagger editor编写接口文档,当然我们这里讲解的是SpringBoot整合Swa

Spring Boot2 系列教程(十七)SpringBoot 整合 Swagger2

前后端分离后,维护接口文档基本上是必不可少的工作. 一个理想的状态是设计好后,接口文档发给前端和后端,大伙按照既定的规则各自开发,开发好了对接上了就可以上线了.当然这是一种非常理想的状态,实际开发中却很少遇到这样的情况,接口总是在不断的变化之中,有变化就要去维护,做过的小伙伴都知道这件事有多么头大!还好,有一些工具可以减轻我们的工作量,Swagger2 就是其中之一,至于其他类似功能但是却收费的软件,这里就不做过多介绍了.本文主要和大伙来聊下 在Spring Boot 中如何整合 Swagger

Spring Mvc和SpringBoot整合Swagger2

各位同学大家好,最近项目赶进度,没有钻研技术的时间,但碰巧今天需要在Spring项目上进行SpringMvc和Swagger的整合,而第一次使用Swagger是在SpringBoot项目上,因此踩了不少的坑,于是想和大家分享一下 :关于Swagger在SpringBoot或者和SpringMvc的集成! 随着开发模式逐渐向前后端分离演变,沟通的成本逐渐增加,前端和后端的唯一联系,变成了API接口:API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API

SpringBoot整合Swagger2简单的例子

Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步.Swagger 让部署管理和使用功能强大的API从未如此简单. 这里我给大家带来一个简单的整合DEMO 先来看项目结构 下面是基本的步骤 一.添加MAVEN依赖 <dependency> <groupId>io.springfox</gro

(六)SpringBoot整合Swagger2框架

一:什么是Swagger Swagger是一款通过我们添加的注解来对方法进行说明,来自动生成项目的在线api接口文档的web服务. 二:添加Swagger2依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency>

SpringBoot整合Swagger2搭建API在线文档

Swagger,中文"拽"的意思,它是一个功能强大的在线API在线文档,目前它的版本为2.x,所以称为Swagger2.Swagger2提供了在线文档的查阅和测试功能.利用Swagger2很容易构建RESTful风格的API,在SpringBoot中集成Swagger2,步骤如下. 1.引入依赖 <!--Swagger2--> <dependency> <groupId>io.springfox</groupId> <artifac

SpringBoot(六) SpringBoot整合Swagger2(自动化生成接口文档)

一:在上篇文章pom增加依赖: <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependency> <groupId>io.springfox</groupId>

【Swagger2】springboot整合swagger2

Swagger 简介 Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端和文件系统作为服务器以同样的速度来更新.文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步. Swagger集成 添加pom依赖 <!--swagger 在线接口生成插件--> <dependency> <groupId>io.springfox</groupId> <artifact