우리는 Miredot를 만드는 회사 인 Qmino에서 수백 개의 REST API를 작성했습니다.우리는 API가 즐겁게 사용될 때까지 디자인하고 재 설계합니다.문서는 API의 사용자 인터페이스입니다.그것은 우리가 굳게 믿는 것입니다.실제로 좋은 API를 과시하는 유일한 방법은 개발자가 즐길 수있는 아름답고 올바른 문서를 제공하는 것입니다.그래서 우리는 문서화에 매우 세심한주의를 기울입니다.우리는 심지어 Javadoc의 부족으로 인해 빌드에 실패하고 코드 검토에는 문서 확인이 포함됩니다.그 다음에, 우리는 Miredot가 REST API 문서에서 잘못된 것을 발견하면 빌드를 실패하게 만듭니다.Miredot 몇 년 전에는 Java 용 REST API 문서 도구를 찾지 못했습니다.우리는 Javadoc, Java 소스 코드, 주석 등과 같은 기존 아티팩트를 취하는 것을 원했습니다.jax-rs, spring 및 jackson과 같은 우리가 사용하는 프레임 워크를 이해하고 아름다운 것으로 바꿉니다.API 소비자가 좋아하는 것.바로 우리가 Miredot을 지속적으로 목표로 삼고 있습니다.그리고 지금까지 우리는 그 결과를 매우 자랑스럽게 생각합니다!
miredot