[springboot 开发单体web shop] 4. Swagger生成Javadoc

最新推荐文章于 2024-05-06 23:26:06 发布

原创

最新推荐文章于 2024-05-06 23:26:06 发布 · 1.5k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#springboot # 电商 #mybatis #generator

本文介绍了如何在SpringBoot项目中集成Swagger2，通过添加依赖、启用功能和配置信息来生成API文档。此外，还展示了如何进一步集成swagger-bootstrap-ui以获得更友好的UI界面，并使用Swagger2Markup生成离线的ASCII和HTML文档。

Swagger生成JavaDoc

在日常的工作中，特别是现在前后端分离模式之下，接口的提供造成了我们前后端开发人员的沟通成本大量提升，因为沟通不到位，不及时而造成的[撕币]事件都成了日常工作。特别是很多的开发人员不擅长沟通，造成的结果就会让自己特别的痛苦，也让合作人员恨的牙根痒痒。为了结束战火蔓延，同时为了提升开发人员的满意度，Swagger应运而生。

什么是Swagger

Swagger for Everyone

Simplify API development for users, teams, and enterprises with the Swagger open source and professional toolset.

Swagger open source and pro tools have helped millions of API developers, teams, and organizations deliver great APIs.

简言之就是指使用工具集简化用户、团队和企业的API开发。

集成Swagger

系统中我选择使用的是swagger-spring-boot-starter。

该项目主要利用Spring Boot的自动化配置特性来实现快速的将swagger2引入spring boot应用来生成API文档，简化原生使用swagger2的整合代码。
看得出来，我在教大家使用的都是在偷懒哦，这可不是什么好现象。。。

添加依赖

        <!--整合Swagger2-->
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.0.RELEASE</version>
        </dependency>

点击版本号进入swagger-spring-boot-starter/1.9.0.RELEASE/swagger-spring-boot-starter-1.9.0.RELEASE.pom，可以看到它依赖的版本信息。

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <version.java>1.8</version.java>
        <version.swagger>2.9.2</version.swagger>
        <version.spring-boot>1.5.10.RELEASE</version.spring-boot>
        <version.lombok>1.18.6</version.lombok>
    </properties>

启用功能

在我们的启动类ApiApplication上增加@EnableSwagger2Doc注解

@SpringBootApplication
@MapperScan(basePackages = "com.liferunner.mapper")
@ComponentScan(basePackages = {"com.liferunner", "org.n3r.idworker"})
@EnableSwagger2Doc //启动Swagger
public class ApiApplication {

    public static void main(Strin