API 문서화

아래만 놓고봤을때는 코드 구조가 잘 짜여있다면 Swagger 그렇지 않은 환경에서는 APIDOCS를 사용함이 좋아보인다.

http://apidocjs.com/example/

https://speakerdeck.com/rottmann/api-documentation

 

  Docs 직접 구현 엑셀+Confluence Swagger APIDOCS Spring Rest Docs
장점

필요한 기능 커스터마이징 가능.

외부 연동시에 

파일로 제공하여 좋다.

컨플루언스가 버전관리 해줌.

설정이 쉽다.

Model 및 API 세부 명세 가능.

사용하기 쉽고 설계적으로 우수함.

설정이 쉽다.

주석베이스라서 사용하기 쉬움.

명시적 단위로 버전관리를 지원함.

VO맵핑 없이 ASIS소스까지 적용할 수 있음.

Test기능을 내장함.

 

SpringBoot와 완벽하게 지원.

프레임워크에 따라 커스터마이징 여지가 많음.

단점

디자인 많이 신경써야함.

엑셀의 단점은 그대로 안고있음.

개발/운영 관리비용이 큼.

귀찮음.

예쁘지 않음.

코드와 동일성 확인 힘듬.

EntityMap을 사용하는 ASIS코드에 적용하기 쉽지 않음.

버전관리를 지원하지 않음.

주석이어서 누락 가능성이 있다.

코드가 길어지면 주석도 길어진다.

npm설치.

릴리즈 멈춤.

설치 및 문서화 설정이 까다로움.

 

 

 

You may also like...

답글 남기기

이메일은 공개되지 않습니다. 필수 입력창은 * 로 표시되어 있습니다.