Swagger项目搭建

本文详述了在Spring MVC项目中集成Swagger的过程,包括环境准备、依赖引入、配置类编写、注解使用等步骤,旨在帮助读者快速搭建能够自动生成文档的Swagger系统。在阅读时,需注意文中提及的环境条件,如JDK版本和项目状态。文章提供完整配置代码,以供参考。遇到问题,作者愿意与读者讨论。
摘要由CSDN通过智能技术生成

一、文章说明

本文由我亲自搭建,搭建过程中出现过各种错误,百度了一大堆教程都没能解决,最后,只能去官网翻资料,加上公司项目的使用结合,终于搭建出来,如果在搭建有新的问题,欢迎与我讨论。
在你看本文章时,有些情况你必须了解清楚,本文章所写的Swager项目的搭建仅在本文所示例的环境,包括不限于JDK版本、依赖库版本等等。还有个前提,需要说明,在配置Swagger项目时,前提是你的Web项目已经可以正常启动且可以访问,如果不能,请先搭建一个可以正常访问的Web应用。另外,本文搭建Swagger不需要下载Swagger的UI资源(依赖jar中已经包含),可省去很多复杂步骤,话不多说,一起来搭建一个自己的Swagger吧!

二、Swagger搭建步骤

环境说明:

  • 一个可以正常访问的Web应用,并且必须是Spring + Spring MVC整合的项目;

  • 必须是Maven构建的项目;

  • 本文使用JDK 1.8;

搭建步骤

  • 在pom.xm中引入Swagger需要的相关依赖
<!-- swagger-springmvc -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

<!-- 除此之外,我们还需要jackson,我使用的是 2.5.0 版本-->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>${jackson.version}</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>${jackson.version}</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>${jackson.version}</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.module</
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
好的,下面是详细步骤: 1. 创建一个新的 Spring Boot 项目。 2. 在 `pom.xml` 文件中添加对 MyBatis、Swagger 和 Nacos 的依赖: ```xml <!-- MyBatis --> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.2.0</version> </dependency> <!-- Swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <!-- Nacos --> <dependency> <groupId>com.alibaba.nacos</groupId> <artifactId>nacos-client</artifactId> <version>1.4.0</version> </dependency> ``` 3. 配置 MyBatis 和数据源,在 `application.properties` 文件中添加以下配置: ```properties # MyBatis mybatis.mapper-locations=classpath*:mapper/*.xml # 数据源 spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver ``` 4. 配置 Swagger,创建一个 `SwaggerConfig` 类: ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Swagger API") .description("Swagger API 文档") .version("1.0.0") .build(); } } ``` 5. 配置 Nacos,创建一个 `NacosConfig` 类: ```java @Configuration public class NacosConfig { @Value("${spring.cloud.nacos.discovery.server-addr}") private String serverAddr; @Value("${spring.application.name}") private String appName; @Bean public void init() { Properties properties = new Properties(); properties.put("serverAddr", serverAddr); NacosConfigService configService = NacosFactory.createConfigService(properties); try { String content = configService.getConfig(appName, "DEFAULT_GROUP", 5000); // 解析配置内容 } catch (NacosException e) { e.printStackTrace(); } } } ``` 注意,上面的代码中使用了 `@Value` 注解,需要在 `application.properties` 文件中添加以下配置: ```properties # Nacos spring.cloud.nacos.discovery.server-addr=localhost:8848 spring.cloud.nacos.discovery.namespace= spring.cloud.nacos.config.namespace= spring.cloud.nacos.config.group=DEFAULT_GROUP spring.cloud.nacos.config.file-extension=properties ``` 至此,你已经成功搭建了一个 Spring Boot 项目,并且集成了 MyBatis、Swagger 和 Nacos。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值