Swagger는 RESTful 스타일의 웹 서비스를 생성, 설명, 호출, 시각화하는 데 사용되는 규범적이고 완전한 프레임워크입니다.전체 목표는 클라이언트와 파일 시스템을 서버로 똑같은 속도로 업데이트하는 것이다.역할:

인터페이스의 문서가 온라인으로 자동으로 생성됩니다

기능 테스트..

프로비저닝

1단계:pom을 설정합니다.xml

    ...
    
    
        io.springfox
        springfox-swagger2
        2.5.0
    
    
    
        io.springfox
        springfox-swagger-ui
        2.5.0
    
  

2단계: IDEA 실행 Reimport All Maven Projects 3단계: 메모를 사용하여 swagger 시작

package com.template.swagger;

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

/**
 * www.1b23.com
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 
                .apis(RequestHandlerSelectors.basePackage("org.fh.controller"))
                .paths(PathSelectors.any())
                .build();
//        return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
    }
    //  api , 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 
                .title("Spring Boot   Swagger2  RESTful API")
                // 
                .contact(new Contact("Bryan", "http://blog.bianxh.top/", ""))
                // 
                .version("1.0")
                // 
                .description("API  ")
                .build();
    }
}

4단계: Controller 구성

package com.template.controller;
/**
 * www.1b23.com
  */
@Api(description = " ")
@Controller("user")
@RequestMapping("/user")
public class UserController extends BaseController {
//...
    @ApiOperation(value = " otp", notes=" OTP ")
    @ApiImplicitParam(name = "telephone", value = " ", paramType = "query", required = true, dataType = "Integer")
    @RequestMapping(value = "getotp", method=RequestMethod.GET)
    @ResponseBody
    public CommonReturnType getOtp(@RequestParam(name = "telephone") String telphone) {
        // OTP 
        Random random = new Random();
        int randomInt = random.nextInt(99999);
        randomInt += 10000;
        String otpCode = String.valueOf(randomInt);

        // OTP , httpsession OTPCode
        httpServletRequest.getSession().setAttribute(telphone,otpCode);
        // OTP ， 
        System.out.println("telphone = " + telphone + "& otpCode = " + otpCode);
        OtpVo otpVo = new OtpVo();
        otpVo.setTelephone(telphone);
        otpVo.setOtpCode(otpCode);
        return CommonReturnType.create(otpVo);
    }
//...
}

단계 5: 액세스http://localhost:8081/swagger-ui.html