2020 - 8 - 5 swagger 의 간단 한 사용

swagger 가 뭐야?
swagger 는 간단하게 말 하면 인터페이스 문 서 를 동적 으로 생 성 하 는 인터페이스 입 니 다.
swagger 를 어떻게 사용 합 니까?
STEP 1: pom 에서 의존 도입
두 번 째 단계: swagger 설정 클래스 만 들 기
세 번 째 단계: 설명 데이터 추가
프로젝트 실행 후 접근http://localhost:8080/swagger- ui. html 동적 으로 생 성 된 인터페이스 문 서 를 볼 수 있 습 니 다.
하나.

    
    
      io.springfox
      springfox-swagger2
      2.9.2
    

    
      io.springfox
      springfox-bean-validators
      2.9.2
    

둘째.

package com.fh.common;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/*swagger   */
@Configuration
@EnableSwagger2
public class SpringFoxConfig {
    @Bean
    public Docket apiDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                //       ，                        。
                .select()
                //       （       ）。          ，         ，         
                .apis(RequestHandlerSelectors.basePackage("com.fh.controller"))
                //                      。          ，               
                .paths(PathSelectors.ant("/Add*/find*"))
                .build();
    }

}

셋.

@Controller
@Api(description = "    ")
@RequestMapping("AddController")
public class AddController {
/*  Id      */
    @PostMapping("findOne")
    @ResponseBody
    @ApiOperation("  Id      ，500    ")
    public JsonData findOne(@ApiParam("    Id")@PathVariable Integer addId){
        try {
            // token      
            String token = request.getParameter("token");
            Buyer buyer = JWT.unsign(token,Buyer.class);
            //Redis   
            if(!RedisPool.hexists("add_"+buyer.getBuyerId(),"add_"+addId)){
                //     
                Address address = addService.findOne(addId);
                //   Redis
                RedisPool.hset("add_"+buyer.getBuyerId(),"add_"+addId,JSONObject.toJSONString(address));
            }
            // Redis 
            String add = RedisPool.hget("add_" + buyer.getBuyerId(), "add_" + addId);
            return JsonData.isSuccess(add);
        }catch (Exception e){
            e.printStackTrace();
            return JsonData.isFailure(500,"  Id        "+e.getMessage());
        }
    }
}