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

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

  1. 去官网 start.spring.io/ 直接按照下图进行初始化,相关配置项具体内容可查看文档,SpringBoot只要不选择SNAPSHOT即可。
    前端初学SpringBoot系列(一)初始化项目以及引入swagger2
  2. 直接通过 IDEA 进行初始化
    前端初学SpringBoot系列(一)初始化项目以及引入swagger2

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

    前端初学SpringBoot系列(一)初始化项目以及引入swagger2
  • 核心java文件在 src/main/java 内部。
  • 应用的配置资源以及后续的 mapper 目录在 src/main/resources 中。其中 application.yml 或者 application.properties 中是应用的配置项:
#服务的端口号
server.port=8082
#服务的根目录
server.servlet.context-path=/api
复制代码

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

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

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

的反射。

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

编写基础接口测试

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

  • 写一个测试类做接口
    前端初学SpringBoot系列(一)初始化项目以及引入swagger2
前端初学SpringBoot系列(一)初始化项目以及引入swagger2

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

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

  1. value 代表请求的URL
  2. method 代表请求的方法,具体内容详见上图的智能提示,如果不写的话,默认就是 GET
  3. params 表示请求参数
  4. heads 请求头的映射条件 以上注解可以 @GetMapping 替换
    前端初学SpringBoot系列(一)初始化项目以及引入swagger2

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

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

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

使用Swagger2展示接口

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

安装 Swagger2 依赖

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

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

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

即可。

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

前端初学SpringBoot系列(一)初始化项目以及引入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

启动类增加新注解 @EnableSwagger2

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

至此,基础的
Swagger2

完成,可以与前端进行基(hu)础(you)联(ni)调(nen),:smile:

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

原文 

https://juejin.im/post/5efb298f5188252e5961a947

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » 前端初学SpringBoot系列(一)初始化项目以及引入swagger2

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址