APIGit은 다양한 보기 모드로 사용자 친화적이고 아름다운 테마의 API 문서를 제공합니다. API 리포지토리 기록의 어느 지점에서나 API 문서를 게시할 수 있으므로 항상 최신 버전의 문서에 액세스할 수 있습니다. 또한 자신의 도메인을 게시된 문서로 지정하여 브랜드 스타일로 표시할 수 있습니다. 일관되고 전문적인 모양과 느낌을 유지하면서 API 문서를 내부 팀 및 외부 파트너와 쉽게 공유할 수 있습니다.
우아하고 명확한 API 문서
게시된 API 문서는 API 사양 및 마크다운 문서의 두 가지 구성 요소로 구성되며 둘 다 API 리포지토리의 파일에서 가져옵니다. 여러 API 문서를 다른 버전으로 게시하고 쉽게 전환할 수 있습니다.
API 사양 보기 모드 - 기본값
API 사양 문서는 API에 대한 포괄적인 이해를 제공하는 다양한 모드로 볼 수 있습니다. 지원되는 모드에는 기본 보기, swagger-UI 및 원시 코드 모드가 포함됩니다. 이를 통해 필요에 가장 적합한 방식으로 API 문서를 보고 상호 작용할 수 있습니다.
API 사양 보기 모드 - swagger UI 모드
Swagger UI 모드에서는 기존 Swagger 테마로 API 문서를 볼 수 있으며 API를 이해하고 상호 작용할 수 있는 친숙하고 사용하기 쉬운 인터페이스를 제공합니다.
API 사양 보기 모드 - 코드 모드
코드 모드에서 원시 API 사양 파일을 보고 기본 코드에 대한 직접 액세스를 제공하여 필요한 경우 쉽게 검토하고 변경할 수 있습니다.
마크다운 문서
게시된 API 문서에는 마크다운 문서도 포함되어 있습니다. API 이면의 디자인 개념과 비즈니스 로직을 제시하기에 이상적인 위치를 제공합니다. 또한 Markdown 문서에 대한 기본 및 코드 모드도 지원하므로 필요에 가장 적합한 방식으로 문서를 보고 검토할 수 있습니다.
맞춤 도메인
사용자 지정 도메인을 설정하면 CNAME 레코드를 사용하여 자신의 도메인이 게시된 문서를 가리키도록 할 수 있으므로 자신의 브랜드 이름과 URL 아래에 문서를 표시할 수 있습니다.
