Dağınık REST ek açıklamaları

Question

Projemde RestEasy kullanarak REST arabirimleri oluşturuyor ve bunları belgelemek için Swagger kullanıyoruz. Sorun bu kadar açıklamaya gerektirir ve aşağıdaki gibi görünebilir şudur:

@ApiOperation(value = "Create a person object", 
     notes = "Create a person object" + 
       "Return the newley created person object", 
     response = Person.class) 
@ApiResponses({ 
     @ApiResponse(code = HttpStatus.SC_INTERNAL_SERVER_ERROR, message = "Internal server error"), 
     @ApiResponse(code = HttpStatus.SC_UNAUTHORIZED, message = "Unauthorized"), 
     @ApiResponse(code = HttpStatus.SC_PRECONDITION_FAILED, message = "Precondition failed"), 
     @ApiResponse(code = HttpStatus.SC_BAD_REQUEST, message = "Bad request"), 
     @ApiResponse(code = HttpStatus.SC_UNPROCESSABLE_ENTITY, message = "Unprocessable entity") 
}) 
@POST 
@Path("rest/v1/persons") 
@Consumes({MediaType.APPLICATION_JSON}) 
@Produces({MediaType.APPLICATION_JSON}) 
Person createPerson(
     @HeaderParam("SecurityToken") String token, 
     @ApiParam(value = "person", defaultValue = "{ \"name\": = \"Bart Simpson\", \"age\": = 9 }") Person person); 

ek açıklamaların çoğu tüm yöntemlerde aynı veya daha az görünüyor. Bu yüzden çok kopyalayıp yapıştırıyoruz ve bu ek açıklamaların tümü arayüzlerimizi oldukça okunamaz hale getiriyor ve yöntemlerin ne yaptığını tam olarak söylemek zor.

Bu yüzden, birisinin aynı işlevselliğe nasıl sahip olabileceğimize dair bir fikri olup olmadığını, ancak bu açıklamaların tümünü ya da en azından bazılarını gizlemeyi düşünerek merak ediyorum.

Answer 1

Özel ek açıklamalar ve bunları jaxrs ve swagger ek açıklamaları ile ek açıklamaları oluşturun. Bahar en RestController iyi bir örnektir:

@Controller 
@ResponseBody 
public @interface RestController { 

} 

Düzenleme: meta-ek açıklamalar Swagger ve/veya RestEasy tarafından desteklenmiyorsa, her zaman bir çözüm olarak APT deneyebilirsiniz.