Springboot整合swagger2,swagger2的简单使用,Java web使用swagger2

开发环境:IntelliJ IDEA ,win10
开发框架:springboot
开发语言:java

1、在pom.xml中引入依赖


<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>2.9.2version>
dependency>
<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>2.9.2version>
dependency>

2.在config包下创建SwaggerConfig类

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

@Configuration
@EnableSwagger2
public class SwaggerConfig {
     
    @Bean
    public Docket createRestApi() {
     
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.nvn.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("SpringBoot整合Swagger")
                        .description("SpringBoot整合Swagger,详细信息......")
                        .version("1.0")
                        .contact(new Contact("标题:","blog.csdn.net","[email protected]"))
                        .license("The Apache License")
                        .licenseUrl("http://www.baidu.com")
                        .build());
    }
}

3、访问localhost:8989/swagger-ui.html 即可,如下
Springboot整合swagger2,swagger2的简单使用,Java web使用swagger2_第1张图片4、使用@Api(tags = “User”) 修改类描述

@Api(tags = "User")
public class UserController {
     
	//略...
}

5、使用@ApiOperation(value = “登录”,notes = “描述:用户登录api接口”)修改方法描述。
notes中可填写html5代码

@PostMapping("login")
@ApiOperation(value = "登录",notes = "描述:用户登录api接口")
public JsonResult login(String accountId, String password, HttpServletRequest request, HttpServletResponse response) {
     
        //略
}

6、运行后,如下图
Springboot整合swagger2,swagger2的简单使用,Java web使用swagger2_第2张图片

本人在本站发布的所有资源文件一律免费!

你可能感兴趣的:(Java,swagger2)