spring auto rest docs의 열거 형 목록 자동 표시가 없음

Question

spring auto rest docs를 사용하여 문서를 생성했습니다. 이것은 java docs 및 spring rest docs와 결합 된 capital.scalable 라이브러리를 사용합니다. 요청 필드를 설명하는 동안 열두 목록 내 내 문제가 있습니다. Type 열은 Array [Object]과 같은 값을 생성합니다. 또한 설명 열에는 문이 열거 형 값과 일치해야하며 열거 형 필드가 아닌 열거 형 일 때 이 생성되어야합니다.

public enum Discipline { 
    ECONOMICS("economics"), 
    SOCIOLOGYANTHROPOLOGY("sociologyanthropology"); 

    private final String discipline; 

    Discipline(final String discipline) { 
    this.discipline = discipline; 
    } 

    public String getId() { 
    return discipline; 
    } 
} 

위의 열거 형은 위와 같습니다. 필드가 열거 형으로 만 사용될 때 설명에 표시하기 위해 tostring을 올바르게 사용합니다. 그러나 열거 형 목록 (예 :

List<Discipline> 

이 필드 인 경우 위와 같이 올바르게 설명하지 않습니다.

문서를보다 효과적으로 생성하기 위해 수행해야 할 작업을 알려주십시오.

Answer 1

열거 형 목록은 아직 제대로 지원되지 않습니다.

이 같은 요청/응답이있는 경우 :

class SomeRequest { 

    public enum EnumTest { 
     ONE, TWO 
    } 

    /** 
    * List of enums 
    */ 
    private List<EnumTest> enumTestList; 
} 

는 순간에 봄 자동 REST 문서 도구 으로 설명되어 있습니다.

형식이 Array[String]이고 설명에 열거 형의 요소가 나열되면 좋을 것입니다. "요소는 [...] 중 하나 여야합니다.

Spring Auto REST Docs 1.0.11은 유형 문제를 수정하므로 Array[String]이이 버전으로 표시됩니다.

열거 형 목록의 문서화를 개선하기 위해 문제점이 열렸습니다 : https://github.com/ScaCap/spring-auto-restdocs/issues/194. 이 문제가 해결 될 때까지 해결 방법으로 "Javadoc 중 하나 인 요소가 [...]"수동으로 추가 될 수 있습니다.