Spring Boot+Swagger整合

最新推荐文章于 2024-11-19 14:38:25 发布
最新推荐文章于 2024-11-19 14:38:25 发布
阅读量483 收藏 1
点赞数 1
分类专栏： swagger 文章标签： swagger

Spring Boot+Swagger整合


1.创建项目

创建Maven项目，配置Spring Boot和Swagger相关项目依赖。

pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.cent.demo</groupId>
    <artifactId>spring-boot-swagger-demo</artifactId>
    <version>1.0-SNAPSHOT</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.1.RELEASE</version>
    </parent>

    <properties>
        <spring.boot.version>1.4.1.RELEASE</spring.boot.version>
        <springfox.version>2.6.0</springfox.version>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- Spring Boot web starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- Swagger2核心包-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${springfox.version}</version>
        </dependency>
        <!-- Swagger2 UI包，前端展示API文档 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${springfox.version}</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.5.1</version>
                <configuration>
                    <source>${java.version}</source>
                    <target>${java.version}</target>
                </configuration>
            </plugin>
            <!-- spring热部署配置 -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.plateno.perpareBooking.PlatenoHissPerpareBookingBootApplication</mainClass>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>org.springframework</groupId>
                        <artifactId>springloaded</artifactId>
                        <version>1.2.5.RELEASE</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>

2.Swagger2配置

创建SwaggerConfig类，通过Spring的javaConfig方式定义Swagger的Bean。可定义多个Docket并配置不同的扫描路径，以实现Api接口的归类。

SwaggerConfig.class：

package org.cent.demo.spring_boot_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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger2配置类
 * Created by cent on 2016/10/31.
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {


    /**
     * swagger摘要bean
     * @return
     */
    @Bean
    public Docket restApi() {
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("org.cent.demo.spring_boot_swagger.controller"))
                .paths(PathSelectors.any())
                .build()
                ;

        return docket;
    }

    /**
     * API文档主信息对象
     * @return
     */
    private ApiInfo apiInfo(){
        ApiInfo apiInfo= (new ApiInfoBuilder())
                .title("Spring Boot集成Swagger项目")
                .description("Spring Boot集成Swagger的Demo API")
                .termsOfServiceUrl("http://localhost:8080/")
                .contact(new Contact("cent","","292462859@qq.com"))
                .version("1.0")
                .build();
        return apiInfo;
    }
}

3.定义API

本示例定义了两个接口，都是查询用户信息接口，一个是通过URI传参的方式，另外一个是通过querystring传参的方式，具体如下：

  • 用户实体对象-User.class:
package org.cent.demo.spring_boot_swagger.entity;

import java.io.Serializable;

/**
 * 用户对象
 * Created by cent on 2016/10/31.
 */
public class User implements Serializable{

    private String id;

    private String name;

    public User() {
    }

    public User(String id, String name) {
        this.id = id;
        this.name = name;
    }

    public String getId() {
        return id;
    }

    public User setId(String id) {
        this.id = id;
        return this;
    }

    public String getName() {
        return name;
    }

    public User setName(String name) {
        this.name = name;
        return this;
    }
}
  • 用户对象业务服务接口-IUserService.class:
package org.cent.demo.spring_boot_swagger.service;

import org.cent.demo.spring_boot_swagger.entity.User;

/**
 * 用户对象业务服务接口
 * Created by cent on 2016/10/31.
 */
public interface IUserService {

    /**
     *
     * @param id
     * @return
     */
    User queryUserById(String id);
}
  • 用户对象业务服务接口实现类-UserServiceImpl.class:
package org.cent.demo.spring_boot_swagger.service.impl;

import org.cent.demo.spring_boot_swagger.entity.User;
import org.cent.demo.spring_boot_swagger.service.IUserService;
import org.springframework.stereotype.Service;

/**
 * 用户对象业务服务接口实现类
 * Created by cent on 2016/10/31.
 */
@Service
public class UserServiceImpl implements IUserService {
    @Override
    public User queryUserById(String id) {

        User user=null;
        if("1".equals(id)){
            user=new User("1","test_user");
        }

        return user;
    }
}
  • 用户操作Restful API入口-UserController.class:
package org.cent.demo.spring_boot_swagger.controller;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.cent.demo.spring_boot_swagger.entity.User;
import org.cent.demo.spring_boot_swagger.service.IUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

/**
 * 用户信息操作相关API接口类
 * Created by cent on 2016/10/31.
 */
@RestController
@RequestMapping(value = "/user")
@Api(description = "用户信息操作相关API")
public class UserController {

    @Autowired
    private IUserService userService;

    @ApiOperation(value = "获取用户详情1", notes = "根据用户ID获取用户详情信息，通过URL传参。")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "String", paramType = "path")
    @RequestMapping(value = "/{id}", method = RequestMethod.GET, produces = "application/json;charset=utf-8")
    public User queryUser1(@PathVariable String id) {
        User user = userService.queryUserById(id);
        return user;
    }


    @ApiOperation(value = "获取用户详情2", notes = "根据用户ID获取用户详情信息，通过querystring传参")
    @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "String", paramType = "query")
    @RequestMapping(method = RequestMethod.GET, produces = "application/json;charset=utf-8")
    public User queryUser2(@RequestParam String id) {
        User user = userService.queryUserById(id);
        return user;
    }
}

4.启动，大功告成

启动SpringBoot，浏览器访问 http://localhost:8080/swagger-ui.html 链接，可看到对应Swagger生成的API文档，并且可以在页面中进行接口测试。

原生的Swagger-UI的API文档在公司内部应该可以直接使用了，不过需要发布给外部使用的话，可能不太合适，但可以对swagger-ui的相关样式/文字进行修改，调整到适合发布即可。

image

5.示例源码地址

阿里Code源码下载地址：https://code.aliyun.com/cent/spring-boot-swagger-demo.git

转载请注明原创出处

原创出自：

https://my.oschina.net/centychen/blog/779260?utm_medium=referral
Swagger详解（SpringBoot+Swagger集成）
ai_miracle的博客
09-14 4万+
Swagger-API文档接口引擎 Swagger是什么 Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 在项目开发中，根据业务代码自动生成API文档，给前端提供在线测试，自动显示JSON格式，方便了后...
springboot + spring security + swagger 整合
不要总是等明天再开始
05-21 9315
springboot整合 spring security 和swagger-ui ： pom.xml文件中添加相关依赖： <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-security</artifactId> .
Swagger 使用指南
皮肤
02-01 2501
Swagger 使用指南
spring集成swagger
李章勇的博客
03-21 334
spring集成swagger 　　随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、前后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。 前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让我们更好地书写API文档的框架。swagger可...
springboot+swagger
yang_zzu的博客
12-10 136
目录 springboot 集成 swagger 自动生成接口文档 1. pom文件 2. properties配置文件 3. swagger的配置类 4. 浏览器访问 springboot 集成 swagger 自动生成接口文档 1. pom文件 <!-- swagger api 自动生成文档 --> <dependency> <groupId>io.springfox</groupId> ..
Spring boot+Mybatis+Mysql+Swagger+filter与intercepter整合
10-19
Spring boot+Mybatis+Mysql+Swagger整合,包括spring boot下创建过滤器filter与intercepter拦截器,使用Intellij idea创建工程，测试OK
spring boot 2.6.11+springcloud Swagger3构建微服务项目源码
10-28
在本项目中，我们主要关注的是使用Spring Boot 2.6.11、Spring Cloud以及Swagger3构建微服务架构的过程。这些技术都是现代云应用开发中的核心组件，它们各自提供了强大的功能来简化开发和增强应用的可维护性。 首先...
Spring boot+vue3+element plus实现后台管理系统
07-04
前后端分离项目，Spring boot作为后端，vue框架实现前端，后端整合swagger3测试工具，jwt实现验证码生成，awt生成图形验证码，整合邮箱验证，使用mybatis-generator自动生成实体类以及mapper，设置有拦截器验证登录...
springboot+myabtis+maven+swagger
08-31
1. **Spring Boot**: Spring Boot是Spring框架的一个扩展，旨在简化Spring应用的初始搭建以及开发过程。它内置了Tomcat服务器，可以快速创建独立运行的Java应用。Spring Boot通过“约定优于配置”的原则，减少了大量...
springboot+Swagger
jarvis的博客
12-13 865
项目目录 pom.xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox<
Springboot + Swagger2.0
Simlier的博客
03-04 347
1. Springboot 整合Swagger 1.1引入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency>
SpringBoot+Swagger (Spring5.x swagger2.x)
混日子的慕程序猿
07-01 473
接触Java四年了。最近才拿框架跑。 springboot，终于弄出来一个。 感谢博客： https://blog.csdn.net/weixin_42953268/article/details/89383024【学习了如何新建一个springboot项目及restful接口】 https://blog.csdn.net/larger5/article/details/79478606【swagger2】 https://blog.csdn.net/larger5/article/details/7932
Spring Boot——集成Swagger
一心同学的博客
12-31 4464
保姆级别讲解Swagger工具，讲解关于Swagger的各种实用知识点以及注意事项。
SpringBoot（7）-Swagger
最新发布
supercool7的博客
11-19 1074
1、我们可以给一些比较难理解的属性或接口，增加注释信息2、接口文档实时更新3、可以在线测试。
Spring Boot整合swagger使用教程（这一篇就够了）
热门推荐
qq_27480007的博客
09-03 3万+
Spring Boot整合swagger使用教程（这一篇就够了）
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值