SwaggerUI的使用_前后端分离架构rest风格

前后端分离以及rest风格介绍在CSDN中一抓一大把我就不介绍了

(主要原因是小编也在学习当中。。。)

给大家提供两个链接:

rest风格介绍

前后端分离的优缺点

进入正题,前后端分离,前台调接口需要通过接口文档才能知道具体调用哪个接口

为方便前台接口调用,后端通过配置swaggerui可以查看具体的接口路径,请求相应参数。

接下来说明后端配置步骤:

1.在pom文件中导入依赖

         
            io.springfox
            springfox-swagger2
            2.2.2
        
        
            io.springfox
            springfox-swagger-ui
            2.2.2
        

2.编写swagger的配置类,配置类的位置要注意

SwaggerUI的使用_前后端分离架构rest风格_第1张图片

package com.ljctest;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.async.DeferredResult;
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 Swagger2 {

    @Bean
    public Docket ProductApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(false)
                .pathMapping("/")
                .select()
                .build()
                .apiInfo(productApiInfo());
    }

    private ApiInfo productApiInfo() {
        ApiInfo apiInfo = new ApiInfo("测试系统数据接口文档",
                "这是一个接口测试文档",
                "1.0.0",
                "API TERMS URL",
                "[email protected]",
                "license",
                "license url");
        return apiInfo;
    }


}

3.在controller中加入相关注解。

SwaggerUI的使用_前后端分离架构rest风格_第2张图片

最后,启动引导类,打开swagger界面查看api文档

SwaggerUI的使用_前后端分离架构rest风格_第3张图片

SwaggerUI的使用_前后端分离架构rest风格_第4张图片

你可能感兴趣的:(restful风格,前后端分离,java,SwaggerUI的使用)