电商商城之整合swagger2方便前端人员进行文档查询

最新推荐文章于 2024-01-03 22:25:31 发布

原创最新推荐文章于 2024-01-03 22:25:31 发布 · 332 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

mall 专栏收录该内容

31 篇文章

订阅专栏

本文介绍如何利用swagger2简化电商商城的文档编写工作，通过代码配置即可自动生成API文档，方便前端人员查阅和对接。

使用swagger2可以减少编写过多的文档，只需要通过代码就能生成文档api提供给前端人员对接

第一步：在pom.xml添加依赖

   <!--   Swagger2 文档生成依赖     -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.4.0</version>
        </dependency>
        这个是可以进行换肤的
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.6</version>
        </dependency>

第二步：通过java类对swagger2进行配置

package com.ljl.config;

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

@Configuration
@EnableSwagger2
public class Swagger2 {
    //官方地址：http://localhost:8080/swagger-ui.html
    //换肤的访问地址： http://localhost:8080/doc.html
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2) //指定api类型为swagger2
                    .apiInfo(apiInfo())                //用于定义api文档汇总信息
                    .select().apis(RequestHandlerSelectors.basePackage("com.ljl.controller")) //指定controller包
                    .paths(PathSelectors.any())        //所有controller
                    .build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("电商平台接口api")                        //文档页标题
                .contact(new Contact("ljl",
                        "https://www.baidu.com",
                        "123@163.com"))                 //联系人信息
                .description("为电商商城提供的api文档")          //详细信息
                .version("1.0.0")                              //文档版本号
                .termsOfServiceUrl("https://www.baidu.com")    //网站地址
                .build();
    }
}