2016-06-22 13 views
5

Tôi đang gặp một số vấn đề nhỏ khi sử dụng Springfox. Tôi không thể đặt tên cho các lớp @RestController.Đặt tên Springfox @RestController

Tôi đang sử dụng Spring boot và Swagger2.

Đoạn mã sau sẽ tạo bộ điều khiển có tên "bộ điều khiển trạng thái nghỉ" trong springfox ui. Thay vào đó, tôi đã mong đợi "Trạng thái ứng dụng". Có cấu hình nào khác mà tôi không biết?

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

Trả lời

15

Cố gắng sử dụng tags tham số của @Api Annotation để thay đổi tên của nhóm các phương pháp RestController của bạn. Trích từ Java tương ứng Doc (rút ngắn):

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

Trong trường hợp của bạn, chỉ cần sử dụng:

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

này nên nhóm tất cả các hoạt động ghi lại từ RestStatusController với từ khóa "Tình trạng ứng dụng".

+0

Sự cố này cần tên riêng. – piepi