Apidog는 API 사양을 전문적이고 인터랙티브한 문서로 변환하는 강력한 게시 기능을 제공합니다. 팀 내부에서 API를 공유해야 하거나 포괄적인 문서를 공개적으로 게시해야 하는 경우 모두, Apidog는 빠른 공유 링크부터 자체 도메인을 사용하는 완전히 사용자 지정된 문서 사이트까지 요구 사항을 충족하는 유연한 옵션을 제공합니다.API 문서 공유#
Apidog는 API 문서를 공유하고 게시하는 여러 가지 방법을 제공하며, 각 방법은 서로 다른 사용 사례에 맞게 설계되었습니다.빠른 공유: 정의된 API 사양에서 한 번의 클릭으로 보기 좋은 API 문서를 생성하며, 신속한 협업에 적합합니다. 인터랙티브 문서: 실습형 API 탐색을 위해 "Try it out" 기능과 온라인 코드 생성을 활성화합니다. 문서 사이트: Markdown 콘텐츠와 API 문서를 결합한 포괄적인 문서 사이트를 게시하여 완전한 사용자 가이드를 제공합니다. 지원되는 API 기술#
Apidog는 사실상 모든 API 기술을 문서화할 수 있도록 포괄적인 지원을 제공합니다. 기존 REST API, 최신 GraphQL, 실시간 WebSocket 연결 또는 엔터프라이즈 SOAP 서비스를 사용하시는 경우에도 Apidog가 지원합니다.지원되는 기술은 다음을 포함합니다: REST, SOAP, GraphQL, gRPC, WebSocket, SSE 등.다양한 API 유형을 효과적으로 문서화하는 방법을 확인하려면 문서화 모범 사례와 실제 API 예시 모음을 살펴보십시오.빠른 공유와 문서 게시 비교#
Apidog는 서로 다른 시나리오에 최적화된 두 가지 고유한 게시 방법을 제공합니다. 두 방법의 차이를 이해하면 요구 사항에 적합한 방식을 선택하는 데 도움이 됩니다.빠른 공유는 신속하고 유연한 협업을 위해 설계되었으며, 개발 중 특정 API를 팀원 또는 외부 파트너와 공유하는 데 이상적입니다. 문서 게시는 완전한 사용자 지정 기능을 갖춘 전문적인 공개용 문서 사이트를 만드는 데 적합하도록 구축되었습니다.기능 비교#
| 기능 | 빠른 공유 | 문서 게시 |
|---|
| 일부 API 게시 | ✓ 지원됨 | 전체 프로젝트만 가능 |
| 사용자 지정 도메인 | ✗ 지원되지 않음 | ✓ 지원됨 |
| 사용자 지정 내비게이션 | ✗ 지원되지 않음 | ✓ 지원됨 |
| 사용자 지정 색상 및 로고 | ✗ 지원되지 않음 | ✓ 지원됨 |
| API Hub에 게시 | ✗ 지원되지 않음 | ✓ 지원됨 |
내부 협업 및 빠른 API 검토에는 빠른 공유를 사용하십시오. 공개적으로 제공할 전문적이고 브랜딩된 문서 사이트가 필요한 경우 문서 게시를 사용하십시오.
