Redocly

Redocly는 전문 개발자 포털을 구축하는 데 도움을 주는 API 문서 플랫폼입니다. API를 설명하는 OpenAPI 파일로 시작하면 Redocly가 이를 깔끔하고 읽기 쉬운 문서로 변환하며, 예제와 인터랙티브 기능도 제공합니다.

이 플랫폼은 여러 제품이 함께 작동합니다. Reunite는 팀이 콘텐츠를 작성하고 검토하는 곳입니다. Realm은 최종 문서를 사용자에게 제공합니다. Redoc은 API 참조 문서를 렌더링하는 오픈 소스 엔진입니다. Reef는 모든 API를 하나의 카탈로그에서 정리하고 발견할 수 있도록 도와줍니다.

기본 문서 생성기와 달리 Redocly는 완전한 개발자 포털을 제공합니다. API 참조와 함께 가이드, 튜토리얼, 맞춤 페이지를 추가할 수 있습니다. 모든 것은 버전 관리되며 API 정의를 변경하면 자동으로 업데이트됩니다.

Redocly 시작하기는 간단합니다. 문서를 작성하는 단계는 다음과 같습니다:

• Redocly 계정에 가입하고 웹사이트에서 무료 평가판을 시작하세요.

• GitHub, GitLab 또는 Azure DevOps에서 코드 저장소를 연결하여 OpenAPI 파일을 자동으로 동기화하세요.

• OpenAPI 정의 파일을 업로드하거나 링크하세요. Redocly는 OpenAPI 버전 2.0, 3.0, 3.1을 지원합니다.

• 색상, 글꼴을 변경하고 로고를 추가하여 브랜드에 맞게 외관을 맞춤 설정하세요.

• Markdown을 사용하여 가이드, 튜토리얼 및 시작하기 섹션과 같은 추가 콘텐츠 페이지를 추가하세요.

• 내장 편집기를 사용해 변경 사항을 작성하고 미리 본 후 게시하세요.

• API 정의를 저장소에서 변경할 때마다 문서가 자동으로 업데이트되도록 자동 빌드를 설정하세요.

• 맞춤 도메인을 구성하여 문서를 자체 웹사이트 주소에서 호스팅하세요.

• OpenAPI 파일로부터 자동 API 문서 생성

• 탐색 및 예제가 포함된 아름다운 3패널 레이아웃

• 엔드포인트 테스트를 위한 인터랙티브 API 콘솔

• 맞춤 브랜딩 및 스타일링 옵션

• 자동 업데이트가 포함된 Git 워크플로우

• 다중 버전 API 지원

• AI 기능이 포함된 고급 검색

• 가이드 및 튜토리얼용 마크다운 지원

• 팀 협업 및 검토 도구

• 맞춤 도메인 호스팅 포함