文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

springboot项目配置swagger2示例详解

2024-04-02 19:55

关注

swagger简介

  Swagger是一款RESTful接口的文档在线自动生成、功能测试功能框架。一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务,加上swagger-ui,可以有很好的呈现。

  当我们在后台的接口修改了后,swagger可以实现自动的更新,而不需要人为的维护这个接口进行测试。

一、swagger2中常用的注解作用

注解 作用
@Api 修饰整个类,描述Controller的作用 ,表示标识这个类是swagger的资源
@ApiOperation 描述一个类的一个方法,或者说一个接口,表示一个http请求的操作
@ApiParam 用于方法的参数,表示对参数的添加元数据
@ApiModelProperty 用于方法,字段。表示对model属性的说明或者数据操作更改

二、springboot项目配置swagger2步骤

1、springboot项目的目录结构如下:

在这里插入图片描述

2、pom.xml文件引入如下配置


<!--引入web相关依赖-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--引入swagger2-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!--引入swagger-ui-->
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.9.2</version>
 </dependency>

3、application.yml配置文件配置如下


server:
  port: 8001 #端口
  servlet:
    context-path: /springSecurity #配置项目名称

4、Swagger配置文件如下:


package com.xz.springsecuritydemo.config;

import com.google.common.base.Predicate;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.ResponseEntity;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;


@Configuration
@EnableSwagger2//开启Swagger2
public class SwaggerConfig {

    //注入配置文件中的项目名称
    @Value("${server.servlet.context-path}")
    private String contextPath;

    
    private ApiInfo initApiInfo() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("springSecurity测试项目 Platform API")//大
                .version( "1.0.0")//版本
                .description(initContextInfo())//描述
                .contact(new Contact("xz", "https://wwwxz.blog.csdn.net/", "123456@qq.com"))//作者信息
                .license("The System Server, Version 1.0")//网站链接显示文字
                .licenseUrl("https://wwwxz.blog.csdn.net/")//网站链接
                .build();

        return apiInfo;
    }

    private String initContextInfo() {
        StringBuffer sb = new StringBuffer();
        sb.append("REST API 设计在细节上有很多自己独特的需要注意的技巧,并且对开发人员在构架设计能力上比传统 API 有着更高的要求。")
                .append("<br/>")
                .append("本文通过翔实的叙述和一系列的范例,从整体结构,到局部细节,分析和解读了为了提高易用性和高效性,REST API 设计应该注意哪些问题以及如何解决这些问题。");

        return sb.toString();
    }

    
    @Bean
    public Docket restfulApi() {
        System.out.println("http://localhost:8001" + contextPath + "/swagger-ui.html");
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(initApiInfo())
                .groupName("RestfulApi")
                //.genericModelSubstitutes(DeferredResult.class)
                .genericModelSubstitutes(ResponseEntity.class)
                .useDefaultResponseMessages(true)
                .forCodeGeneration(false)
                .pathMapping(contextPath) // base,最终调用接口后会和paths拼接在一起
                .select()
                 //加了ApiOperation注解的类,才生成接口文档
                 //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                 //暴露接口地址的包路径(即此包下的类,才生成接口文档)
                .apis(RequestHandlerSelectors.basePackage("com.xz.springsecuritydemo.modules.sys.controller"))
                .paths(doFilteringRules())//自定义的过滤规则
                .build();
    }

    
    private Predicate<String> doFilteringRules() {
        return or(
                regex("/testUser.*"),
                regex("/hello.*")
        );
    }
}

5、用户实体类如下:


package com.xz.springsecuritydemo.modules.sys.entity;

import io.swagger.annotations.ApiModelProperty;

public class UserQueryCondition {
    private int id;
    @ApiModelProperty(value = "用户名称")
    private String name;
    private int age;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

6、控制层代码如下:


package com.xz.springsecuritydemo.modules.sys.controller;

import com.xz.springsecuritydemo.modules.sys.entity.User;
import com.xz.springsecuritydemo.modules.sys.entity.UserQueryCondition;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.apache.commons.lang.builder.ReflectionToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.springframework.web.bind.annotation.*;

@Api(value = "API - UserController",description = "用户模块接口详情")
@RestController
@RequestMapping("/testUser")
public class UserController {

    
    @RequestMapping(value = "/queryUserByName",method = RequestMethod.GET)
    @ApiOperation(value = "根据用户名称查询服务")
    public void queryUserByName(@ApiParam(value = "用户username") @RequestParam(name="username",required = false, defaultValue ="tom" ) String name){
        System.out.println("queryUser====="+name);
    }

    
    @RequestMapping(value = "/queryUserAll",method = RequestMethod.GET)
    @ApiOperation(value = "根据用户id、名称和年龄查询服务")
    public void queryUserAll(UserQueryCondition userQueryCondition){
        //利用反射工具把对象输出
        System.out.println(ReflectionToStringBuilder.toString(userQueryCondition, ToStringStyle.MULTI_LINE_STYLE));
    }

    
    @PostMapping(value = "/createUser")
    @ApiOperation(value = "用户新增服务")
    public User userCreate1(@RequestBody User user){
        System.out.println(user.getName()+"----"+user.getPassword());
        user.setId(1);
        return user;
    }

    
    @PutMapping("/{id:\\d+}")
    @ApiOperation(value = "用户修改服务")
    public User update(@RequestBody User user){
        System.out.println(user.getId()+"======"+user.getName()+"----"+user.getPassword());
        user.setId(1);
        return user;
    }

    
    @DeleteMapping("/{id:\\d+}")
    @ApiOperation(value = "用户删除服务")
    public void delete(@PathVariable String id){
        System.out.println(id);
    }
}

7、启动项目,如下图:

在这里插入图片描述

8、启动项目后,访问 http://localhost:8001/springSecurity/swagger-ui.html,如下图:

在这里插入图片描述

9、点击user-Controller,如下图所示:

在这里插入图片描述

10、点击具体某一方法,可以看到如下信息:

在这里插入图片描述

三、示例中使用的注解解析

1、@Api注解标注在了控制层的UserController类上,如下图画红色框的位置可以看到注解生效。

在这里插入图片描述

在这里插入图片描述

2、@ApiOperation注解标注在了控制层的UserController类的方法上,如下图画红色框的位置可以看到注解生效。

在这里插入图片描述

在这里插入图片描述

3、@ApiParam注解标注在了控制层的方法参数上,如下图画红色框的位置可以看到注解生效。

在这里插入图片描述

在这里插入图片描述

4、@ApiModelProperty注解标注在了实体中的属性上,在控制层方法接收实体对象时生效,如下图画红色框的位置可以看到注解生效。

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

到此这篇关于springboot项目配置swagger2示例详解的文章就介绍到这了,更多相关springboot配置swagger2内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

阅读原文内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯