swagger2实战:springboot swagger2结合实战,swagger2入门教程

前言

swagger2 作为API接口生成的利器,极大的方便了前后端调试的成本。后端研发人员无需关注接口文档的梳理,可以以界面话的方式友好呈现出来。

实战

  1. pom.xml文件引入jar包:
        <!-- 集成Swagger2接口测试工具(类似于postman) -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
  1. springboot 的启动主类,添加一下注解:
//开启对swagger的支持
@EnableSwagger2
  1. 新建swagger2的配置类:
package com.plugs.swagger;

import org.springframework.context.annotation.Bean;

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;

public class Swagger2Config {
    
    

	@Bean
	public Docket createRestApi() {
    
    
		return new Docket(DocumentationType.SWAGGER_2)
				.apiInfo(apiInfo())
				.select()
				.paths(PathSelectors.any())
				.build();
	}

	private ApiInfo apiInfo() {
    
    
		return new ApiInfoBuilder()
				.title("springboot利用swagger构建api文档")
				.description("")
				.termsOfServiceUrl("")
				.version("1.0")
				.build();
	}

}
  1. 访问:ip:端口/项目名/swagger-ui.html
    在这里插入图片描述

  2. 获取完整源码地址: https://download.csdn.net/download/penggerhe/11670196

  3. 公众号关注,免费领取:
    在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/penggerhe/article/details/108337670