Spring Boot 통합 Swagger, 인터페이스 문 서 를 만 드 는 것 이 이렇게 간단 합 니 다!

이전 글 에 서 는 '인터페이스 API 디자인 신기 추천!' 을 소 개 했 는데, 오늘 스 택 장 이 우수한 Spring Boot 프레임 워 크 와 통합 하 는 방법 을 소개 하 는 것 은 쉽 지 않다.
네가 갖 춰 야 할 기초

스프링 부츠 는 정말 강 한 물건 이 라 고 말 해 줄 게!

Spring Boot 핵심 프로필 상세 설명

Spring Boot 가 열 리 는 2 가지 방식

스프링 부츠 자동 배치 원리, 실전

Spring Boot 2. x 시작 전 과정 소스 분석

더 많은 자바 기술 스 택 위 챗 공식 번호 배경 에 키워드: boot 를 답장 하 십시오.
스프링 부 트 통합 Swagger
1. 의존 도 추가
Maven 의존 예시:

    io.springfox
    springfox-swagger2


    io.springfox
    springfox-swagger-ui

2. Spring Boot 설정 파일 에 설정 파 라 메 터 를 추가 합 니 다.

swagger:
  title: API  
  description: API  
  version: 1.0
  terms-of-service-url: http://www.javastack.cn/
  base-package: cn.javastack.test.web
  contact:
    name: Javastack
    url: http://www.javastack.cn/
    email: [email protected]

3. 설정 클래스 추가

@Getter
@Setter
@Configuration
@EnableSwagger2
@ConditionalOnClass(EnableSwagger2.class)
@ConfigurationProperties(prefix = "swagger")
public class SwaggerConfig {

    /**
     * API     
     */
    private String basePackage;

    /**
     * API    
     */
    private String title;

    /**
     * API  
     */
    private String description;

    /**
     *       
     */
    private String termsOfServiceUrl;

    /**
     *    
     */
    private String version;

    /**
     *    
     */
    private Contact contact;
    
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)
                .version(version)
                .contact(contact)
                .build();
    }

}

어떻게 사용 합 니까?
Swagger 는 기본적으로 설 정 된 가방 에 따라 모든 인 터 페 이 스 를 스 캔 하고 해당 하 는 API 설명 과 매개 변수 정 보 를 생 성 합 니 다. 그러나 이것 은 직관 적 이지 않 습 니 다. 모든 인터페이스 와 매개 변수 에 대해 사용자 정의 설명 이 필요 합 니 다.
자주 사용 하 는 Swagger 주 해 는 다음 과 같 습 니 다.
주해 명
사용 설명
@Api
API 클래스 설명
@ApiImplicitParam
요청 인자 설명
@ApiImplicitParams
요청 매개 변수 설명
@ApiModel
되 돌아 오 는 대상 설명
@ApiModelProperty
되 돌아 오 는 대상 매개 변 수 를 설명 합 니 다.
@ApiOperation
API 방법 설명
@ApiParam
방법 을 설명 하 는 인자
@ApiResponse
요청 응답 설명
@ApiResponses
요청 응답 설명
예 를 들 어:

@Api(description = "    ")
@RestController
public class LoginController {
    
    @ApiOperation(value = "  ", httpMethod = "POST")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "username", value = "   ", dataType = "string", paramType = "query"),
            @ApiImplicitParam(name = "password", value = "  ", dataType = "string", paramType = "query")})
    @PostMapping(value = "/login")
    public Object login(@RequestParam("username") String username, @RequestParam("password") String password) {
    
        // ...
          
    }
}

http://localhost:8080/swagger-ui.html
swagger - ui 인터페이스 를 열 면 모든 API 인터페이스 정 의 를 볼 수 있 고 위 에서 인터페이스 테스트 를 할 수 있 습 니 다.
자바 기술 스 택 위 챗 공식 번 호 를 주목 하고 배경 에서 답장 합 니 다. 도구, 스 택 장 이 정리 한 더 많은 도구 묘 기 를 얻 습 니 다. 모두 실전 건어물 입 니 다. 다음은 일부 미리 보기 입 니 다.

자바 개발 에 필수 적 인 해외 10 대 사이트

무료 온라인 창작 절차 도, 사고 지도 소프트웨어

코드 신 기 를 추천 합 니 다. 코드 량 이 적어도 절반 은 절약 합 니 다!

인터페이스 API 디자인 신 구 를 추천 합 니 다!

아주 상세 한 Git 실전 튜 토리 얼, 바보 도 딱 봐 도!

……

본 고 는 위 챗 공식 번호: 자바 기술 스 택 (id: javastack) 에서 최초 로 시작 되 었 습 니 다. 공중 번호 가 배경 에서 '도구' 를 답장 하면 더 많은 것 을 얻 을 수 있 습 니 다. 이 정 보 를 그대로 유지 하 십시오.