2016-06-22 12 views
5

Otrzymuję drobne problemy przy użyciu Springfox. Nie mogę ustawić nazwy klas @RestController.Springfox @RestController nazewnictwo

Używam Spring Boot i Swagger2.

Poniższy kod wyświetli kontroler o nazwie "rest-status-controller" w Springfox ui. Spodziewałem się zamiast tego "Statusu aplikacji". Czy istnieje inna konfiguracja, której nie znam?

@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() { 
    //... 
    } 
} 

Odpowiedz

15

spróbuj użyć parametru @Api Adnotacja tags zmienić nazwę ugrupowania swoimi metodami RestController. Wypis z odpowiedniego Java Doc (skrócony):

/** 
* 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 ""; 

W Twoim przypadku, wystarczy użyć:

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

Powinno to grupa wszystkich udokumentowanych operacji z RestStatusController z tagiem "Status Application".

+0

To wydanie wymaga własnej nazwy. – piepi

Powiązane problemy