正文

[idea]springboot整合swagger2实现crud

赤青1  2022-04-30  432

关键词：

一：创建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　　　　　//beans
public 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","[email protected]"))//创建人
                .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

springboot整合swagger

本文github位置：https://github.com/WillVi/springboot-swagger2-demo环境准备JDK版本：1.8Springboot版本：1.5.16Swagger及其Swagger-ui版本：2.6.1（关于swagger-ui版本每个版本的汉化方式可能有不同）默认url：http://localhost:8080/swagger-ui.htmlMaven依赖查看详情

springboot学习——springboot快速整合swagger文档

@[toc]简介优点后端根据swagger语法，自动生成漂亮规范的接口文档。做交互测试。劣势侵入式的，影响程序运行，尤其是传参的时候。注意swagger分1.2版本和2.0版本，差异较大。swagger1.2即swagger-ui；swagger2.0即springfox-swagger。本文介... 查看详情

springboot整合swagger

Swagger使用Swagger有什么用?swagger是一个流行的API开发框架，这个框架以“开放API声明”（OpenAPISpecification，OAS）为基础，对整个API的开发周期都提供了相应的解决方案，是一个非常庞大的项目（包括设计、编码和测试，... 查看详情

springboot整合swagger-ui快速生成在线api文档

目录SpringBoot整合Swagger-ui实现在线API文档本篇要点一、restful风格简单介绍二、SpringBoot与Swagger-ui快速整合1、第一种方式：使用官方依赖2、第二种方式：使用第三方依赖三、swagger-ui的基本注解源码下载参考阅读SpringBoot整合Swagger-u... 查看详情

swaggerlearing-springboot整合swagger

学习了一下swagger。这是编写的Demo源码https://github.com/AmberBar/Learning/tree/master/swagger-learning/swagger需要的小伙伴可以clone直接运行访问地址http://localhost:9999/swagger-ui.html#/ 查看详情

在springboot中整合jersey和springfox-swagger2

前言为了实现RESTfulWebservice和接口说明，基于springboot平台，使用jersey作为JAX-RS的实现，采用swagger文档在线生成工具。提要在实现了springboot集成jersey的swagger文档功能，同时满足SpringMVC整合swagger提供RESTful文档功能。Springboot 集... 查看详情

swagger和springboot整合

Swagger号称全世界最流行的api框架；RestFulApi文档在线自动生成工具=>Api文档与API定义同步更新配置<dependency> <groupId>io.springfox</g 查看详情

springboot和swagger整合

本文来源：https://blog.csdn.net/saytime/article/details/74937664一、依赖<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version& 查看详情

springboot整合swagger-ui

SpringBoot整合Swagger-ui引入依赖<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency>< 查看详情

springboot整合swagger2

一关于SwaggerSwagger能成为最受欢迎的RESTAPIs文档生成工具之一，有以下几个原因：Swagger可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。Swagger可以生成客户端SDK代码用于各种不同的平台上的实现。Swagger... 查看详情

springboot整合swagger

...Api到Postman测试，耗费了不少时间。这次新项目决定使用SpringBoot来做，各方面都节省了不少配置，一想到Api的对接就有点头大，于是决定把Swagger集成进来，实现Api文档的自动生成（通过http://localhost:8080/swagge 查看详情

springboot整合swagger2

　　手写Api文档的几个痛点：文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。接口返回结果不明确不能直接在线测试接口，通常需要使用工具，比如postman接口文档太多，不好管理　　Swagger也就是... 查看详情

springboot整合swagger测试api构建

@Author:SimpleWu什么是Swagger？Swagger是什么：THEWORLD’SMOSTPOPULARAPITOOLING根据官网的介绍：SwaggerInspector：测试API和生成OpenAPI的开发工具。SwaggerInspector的建立是为了解决开发者的三个主要目标。执行简单的API测试生成OpenAPI文档探索新... 查看详情

springboot整合swagger2搭建api在线文档

...阅和测试功能。利用Swagger2很容易构建RESTful风格的API，在SpringBoot中集成Swagger2，步骤如下。1.引入依赖<dependency><groupId> 查看详情

springboot整合swagger框架

Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码，允许API来始终保... 查看详情

springboot2整合swagger2-plus

目录一.整合swagger21.加依赖2.写配置3.常用注解：4.演示demo5.实际效果查询新增登录二.整合swagger2-plus1.加依赖2.写配置3.实际应用4.最终效果新增登录一.整合swagger21.加依赖<dependency><groupId>io.springfox</gr... 查看详情

springboot整合swagger常见问题一

项目启动完,访问swagger-ui页面访问不到,这里可以给他指定一下,创建一个实体类即可@SuppressWarnings("deprecation")@Configurationpublic class WebMVCConfig extends WebMvcConfigurerAdapter { &nb 查看详情

springboot整合swagger2框架

一：什么是SwaggerSwagger是一款通过我们添加的注解来对方法进行说明，来自动生成项目的在线api接口文档的web服务。二：添加Swagger2依赖<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><ve 查看详情