4. enable swagger2 for spring boot

最新推荐文章于 2024-03-05 20:46:59 发布

原创

最新推荐文章于 2024-03-05 20:46:59 发布 · 871 阅读

标签

#spring boot #swagger

本文介绍了如何在Spring Boot项目中集成Swagger2，包括在父模块和子模块中添加依赖，配置Swagger2，启用Swagger2以及隐藏不需要展示的Vo字段。通过这些步骤，开发者可以方便地创建API文档并进行测试。

Table of Contents

添加swagger2的相关依赖包

在父模块的pom中添加对swagger2的版本管理

在web子模块中添加对swagger2包的依赖

在front子模块中添加对swagger2包的依赖

实现swagger2配置文件

启用swagger2

参考

添加swagger2的相关依赖包

在父模块的pom中添加对swagger2的版本管理

social-network-serverless/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%20https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.jessica</groupId>
    <artifactId>social-network-serverless</artifactId>
    <packaging>pom</packaging>
    <version>0.0.1-SNAPSHOT</version>
    <name>social-network-serverless</name>
    <description>spring boot project with aws serverless service</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <modules>
        <module>social-network-serverless-web</module>
        <module>social-network-serverless-front</module>
        <module>social-network-serverless-service</module>
        <module>social-network-serverless-dao</module>
        <module>social-network-serverless-dto</module>
        <module>social-network-serverless-common</module>
    </modules>

    <dependencyManagement>
        <dependencies>
            <!--project modules-->
            <dependency>
                <groupId>com.jessica</groupId>
                <artifactId>social-network-serverless-web</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>com.jessica</groupId>
                <artifactId>social-network-serverless-front</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>com.jessica</groupId>
                <artifactId>social-network-serverless-service</artifactId>
                <version>${project.version}</version>
            </dependency>
            <dependency>
                <groupId>com.jessica</groupId>
                <art

最低0.47元/天解锁文章