IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解

IntelliJ IDEA搭建一个java 的API接口项目。

IntelliJ IDEA下载地址:https://www.jetbrains.com/idea/download/#section=windows

最终效果图展示:

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第1张图片

 

整体目录结构:

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第2张图片

 

1.创建一个maven项目

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第3张图片

如图,新建项目里面选择Maven,然后Next。

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第4张图片

输入groupid和artifactid,然后Next。

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第5张图片

直接finish。一个maven项目创建好了。

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第6张图片

2.创建目录结构,引入pom依赖

    
    
        org.springframework.boot
        spring-boot-starter-parent
        1.5.8.RELEASE
         
    

    
        
            org.springframework.boot
            spring-boot-starter
        

        
            org.springframework.boot
            spring-boot-starter-web
        

    

   目录结构:

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第7张图片

 创建配置文件:application.yml和application-dev.yml

application.yml文件内容:    配置服务端口,不配置默认8080

# 配置端口
server:
  port: 6688
spring:
  profiles:
#  配置的环境
    active: dev

3.接下来,配置mybatis

   3.1先引入pom依赖

  

        
        
            org.mybatis.spring.boot
            mybatis-spring-boot-starter
            1.3.1
        

 3.2 将mybatis配置添加进application.yml

# mybatis 配置
mybatis:
  config-location: classpath:mybatis/mybatis-config.xml
  mapper-locations: classpath:mybatis/mapper/*.xml

    因为之前配置application.yml用的是dev的环境配置,所以这里在dev配置文件中添加数据库连接信息同时添加mysql依赖

        
        
            mysql
            mysql-connector-java
            runtime
        
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://数据库服务器地址/studb?useUnicode=true&characterEncoding=utf-8
    username: write
    password: write123

3.3引入数据库自动映射工具依赖

     

    
        
            
                org.mybatis.generator
                mybatis-generator-maven-plugin
                1.3.2
                
                    
                    
                    true
                    
                    true
                
                
                    
                        org.mybatis.generator
                        mybatis-generator-core
                        1.3.2
                    
                
            
        
    

再配置文件中添加工具XML。。。。

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第8张图片

generatorConfig.xml 内容:




    

    

        
            
        

        
        
        


        
            
        

        
        
            
            
        

        
        
            
        

        
        
            
        

        
        
        
targetProject 配置的文件生成地址,配置完成后即可执行工具。

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第9张图片

点击运行。。

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第10张图片

生成成功。然后到配置地址获取生成内容。拷贝至项目中对应位置

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第11张图片

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第12张图片

到这里一个springboot+mybatis项目搭建完成了,接下来接下来就是添加swagger。。。

4.添加swagger工具

  4.1 添加swagger依赖

        
        
            io.springfox
            springfox-swagger2
            2.6.1
        

        
            io.springfox
            springfox-swagger-ui
            2.6.1
        

4.2 添加swagger类

IDEA搭建一个spring boot+mybatis+maven+swagger的api接口项目详解_第13张图片

package com.test.apitestpro.controller;

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger {
    @Bean
    public Docket helloApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.test.apitestpro.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("api文档")
                .description("搭建spring boot+mybatis+maven+swagger的测试项目")
                .termsOfServiceUrl("http://接口IP")
                .version("v1")
                .build();
    }
}

现在就可以愉快的撸业务代码了,一个接口项目就搭建完成了。。。

项目demo可以在这里获取:https://github.com/lrx13558703/-IDEA-java-

 

你可能感兴趣的:(java)