다양한 모드로 API 문서 보기

APIGit

2022-11-15

APIGit은 API 문서를 볼 수 있는 유연하고 사용자 친화적인 환경을 제공합니다. 다른 뷰어 간에 쉽게 전환하여 다른 관점에서 동일한 문서를 볼 수 있으므로 API 및 해당 기능을 더 깊이 이해할 수 있습니다. 기본 뷰어는 인기 있는 오픈 소스 Redoc 뷰어를 사용하여 구축되어 API 문서를 쉽게 탐색하고 이해할 수 있는 매력적이고 직관적인 레이아웃을 제공합니다.

API main

Swagger 뷰어는 API 문서를 시각화하기 위한 클래식하고 사용하기 쉬운 옵션입니다. 명확하고 효율적인 탐색을 허용하는 단순하고 깔끔한 레이아웃을 제공합니다. 또한 이 뷰어는 성능에 최적화되어 있으므로 크거나 복잡한 API 문서에 이상적인 선택입니다. 간단하고 이해하기 쉬운 API 문서를 이해하고 탐색하는 전통적인 방법을 제공합니다.

swagger UI

코드 뷰어는 API 문서의 원시 및 형식 없는 보기를 제공하여 사용자에게 문서의 기본 구조 및 형식에 대한 자세한 정보를 제공합니다. 이 뷰어는 사용자가 API에 사용된 정확한 코드와 형식을 볼 수 있도록 하므로 디버깅 오류에 특히 유용합니다. 또한 API 개발 전문가에게 코드 뷰어는 기본 코드에 쉽게 액세스할 수 있도록 API 문서를 편집하는 효율적인 방법이 될 수 있습니다. 이 뷰어는 보다 기술적인 방식으로 API 문서를 이해하고 변경하려는 개발자 및 전문가에게 가장 적합한 선택입니다.

Code viewer

Diff 뷰어를 사용하면 사용자가 저장소 내에서 서로 다른 두 API 문서를 비교할 수 있습니다. 이 기능은 자동 생성된 API 문서의 변경 사항을 쉽게 검토하고 이해할 수 있으므로 타사 통합에 특히 유용합니다. API 문서의 변경 사항을 비교하고 업데이트를 더 잘 이해하는 데 도움이 됩니다. 업데이트를 검토하고 변경 사항을 병합하며 API 문서의 일관성을 보장하는 훌륭한 도구입니다.

diff viewer