使用Swagger自动生成API说明文档

最新推荐文章于 2023-05-21 14:31:31 发布

AI边城

最新推荐文章于 2023-05-21 14:31:31 发布

阅读量1k

点赞数

CC 4.0 BY-SA版权

分类专栏：爱旅行项目文章标签： swagger

本文链接：https://blog.csdn.net/qq_28372705/article/details/86225123

爱旅行项目专栏收录该内容

9 篇文章 ¥9.90 ¥99.00

订阅专栏

本文档介绍了如何在基于jdk1.8、spring4.1.7和tomcat8.5.37的环境中集成Swagger，通过详细步骤包括添加依赖、配置SwaggerConfig和修改Spring MVC配置，实现API接口的自动生成。同时，文章讲解了Swagger注解的使用，如@Api、@ApiOperation、@ApiParam、@ApiModel和@ApiModelProperty，帮助理解如何为接口和参数添加说明。

项目环境

jdk1.8
spring4.1.7
tomcat8.5.37

集成步骤

1.在pom文件中添加swagger依赖

 <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.4.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.4.0</version>
        <exclusions>
            <exclusion>
                <groupId>org.springframework</groupId>
                <artifactId>spring-aop</artifactId>
            </exclusion>
        </exclusions>
    </depen

了解本专栏