Springfox @RestController 명명

Springfox @RestController 명명

Springfox를 사용하는 데 약간의 문제가 있습니다.@RestController 클래스에 이름을 설정할 수 없습니다.

저는 스프링부츠와 스웨거2를 사용하고 있습니다.

다음 코드는 springfoxi에서 "rest-status-controller"라는 이름의 컨트롤러를 생성합니다.대신 "응용 프로그램 상태"를 예상했습니다.내가 모르는 다른 구성이 있습니까?

@Api("Application Status")
@RestController
@RequestMapping("/rest/status")
public class RestStatusController {

    @ApiOperation(value="Get components current status")
    @RequestMapping(method = RequestMethod.GET, produces=MediaType.APPLICATION_JSON)
    public String global() {
    //...
    }

    @ApiOperation(value="Get mysql current status")
    @RequestMapping(value="/mysql" method = RequestMethod.GET, produces=MediaType.APPLICATION_JSON)
    public String mysql() {
    //...
    }
}

사용해 보십시오.tags의 매개 변수@ApiRestController 메서드의 그룹 이름을 변경하는 주석입니다.해당 Java Doc에서 발췌(간단):

/**
 * A list of tags for API documentation control.
 * Tags can be used for logical grouping of operations by resources or any other qualifier.
 */
String[] tags() default "";

이 경우 다음을 사용합니다.

@Api(tags = "Application Status")
@RestController
@RequestMapping("/rest/status")
public class RestStatusController {
    ...
}

이렇게 하면 문서화된 모든 작업을 그룹화할 수 있습니다.RestStatusController"Application Status" 태그를 사용합니다.

컨트롤러 이름 API 그룹화를 방지하려면 태그와 설명을 모두 사용합니다.예:

@Api(
  tags="Application Status.",
  description = "Provides Application Status API's.
")

@Tags(name = "name", description = "description")OpenApi v3에 따름

OpenApi v3의 경우:

@Tag(name = "name")

언급URL : https://stackoverflow.com/questions/37961620/springfox-restcontroller-naming