enum

Restdocs Enum 공통코드 문서화 방법 - Enum 문서화

문서 작성 시 사용되는 타입에 enum이 없기 때문에 enum인 경우 따로 보기좋게 만들 수 있다. 예를 들어, Hobby와 Role의 Enum 클래스를 문서로 만들 수 있다. 먼저 interface를 정의한다. public interface DocsEnumType { String getType(); String getDescription(); } enum은 interface를 상속받아 메서드를 구현할 수 있는데, interface를 구현하게 되면, 다른 메소드나 생성자에서 인터페이스로 enum을 참조 할 수 있다. 만약 문서화가 필요한 Enum이라면 DocsEnumType 인터페이스를 상속받아야 하고, DocsEnumType을 상속받은 모든 enum은 getType()과 getDescription()을..