转载

前端初学SpringBoot系列（一）初始化项目以及引入swagger2

这是前端初学SpringBoot系列的第一节，学习如何初始化一个空项目进行后续开发。目前有两种方式进行初始化：

去官网 start.spring.io/ 直接按照下图进行初始化，相关配置项具体内容可查看文档，SpringBoot只要不选择SNAPSHOT即可。
直接通过 IDEA 进行初始化

初始化后的目录结构如下图所示：

核心java文件在 src/main/java 内部。
应用的配置资源以及后续的 mapper 目录在 src/main/resources 中。其中 application.yml 或者 application.properties 中是应用的配置项：

#服务的端口号
server.port=8082
#服务的根目录
server.servlet.context-path=/api
复制代码

至此，项目已经可以通过启动类 SpringbootDemoApplication 然后 run ，项目会通过内置的 tomcat 服务器起来， spring 就是做的这么友好。

其中应用的启动类用了基础注解 @SpringBootApplication ，注解是SpringBoot项目中特别灵活好用的方式，使用了 java

的反射。

编写基础接口测试

对于前端来说还是喜欢在浏览器上看到直观的现象，目前只能在控制台看到不报错而已，并不是很形象，所以接下来编写一个最基础的接口来体会一下。

写一个测试类做接口

这是一个最简单的接口，通过使用两个注解 @RestController @RequestMapping 完成 Resultful 风格的接口。其中 @RequestMapping

接收多个参数,常见的有以下四个参数：

value 代表请求的URL
method 代表请求的方法，具体内容详见上图的智能提示，如果不写的话，默认就是 GET
params 表示请求参数
heads 请求头的映射条件以上注解可以 @GetMapping 替换

此时访问浏览器的接口，会看到响应内容：

以上是基础的接口编写过程，实际中场景比以上复杂多变，但是目前迅速的体验一个接口还是可以的。

使用Swagger2展示接口

对于以 java 为服务端语言的 web项目 来说，前后端联调接口最常用的就是 Swagger ，接下来学习引入 Swagger2 ，并展示接口内容。

安装 `Swagger2` 依赖

在 pom.xml 中为 <dependecies></dependecies> 增加子依赖，相关配置内容为

当增加新的配置后，选择 Enable Auto-Import

即可。

依赖安装完毕之后，书写 Swagger2的配置

书写 `Swagger2` 配置

使用两个注解 @Configuration @Bean

package com.wushao.springbootdemo;
//各种import...
@Configuration
public class Swagger2Config {
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("api文档")
                .description("测试Swagger2的api文档")
                .termsOfServiceUrl("").version("1.0")
                .build();
    }
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wushao.springbootdemo"))
                .paths(PathSelectors.any())
                .build();
    }
}

复制代码

以上就是 Swagger2 的基础配置项，最后关键一步是让启动类识别 Swagger