Scalar

Scalar는 전문적이고 원활하게 작동하는 API 문서 작성 플랫폼입니다. OpenAPI 문서를 제공하면 Scalar가 예제와 테스트 도구가 내장된 읽기 쉬운 페이지로 변환해 줍니다.

이 플랫폼은 여러 제품이 함께 작동합니다. API 참조는 깔끔한 레이아웃으로 문서를 보여주고, API 클라이언트는 개발자가 엔드포인트를 직접 테스트할 수 있게 합니다. 또한 여러 버전의 API 문서를 관리하고 GitHub와 동기화하는 도구도 포함되어 있습니다.

Scalar는 완전한 오픈 소스로, 코드는 공개되어 있으며 무료로 사용할 수 있습니다. 직접 호스팅하거나 클라우드 서비스를 이용할 수 있습니다. 무료 플랜은 기본 기능을 제공하며, 유료 플랜은 협업 도구, 맞춤 도메인, 향상된 지원을 추가로 제공합니다.

Scalar 사용은 간단하며 복잡한 설정이 필요하지 않습니다. 시작하는 단계는 다음과 같습니다:

• Scalar 웹사이트를 방문하여 무료 계정을 생성하고 작업을 저장하세요. yourname.apidocumentation.com과 같은 무료 서브도메인을 받게 됩니다.

• URL 붙여넣기, 파일 업로드 또는 GitHub 연결을 통해 OpenAPI 문서를 업로드하세요. Scalar는 JSON과 YAML 형식을 모두 지원합니다.

• 테마를 선택하고 브랜드에 맞게 색상을 맞춤 설정하세요. 디자인을 더 세밀하게 조정하고 싶다면 커스텀 CSS를 추가할 수 있습니다.

• 에디터를 사용하여 추가 가이드를 작성하세요. 이 페이지들은 자동 참조 페이지를 넘어서는 개념을 설명합니다.

• 내장된 클라이언트를 사용하여 API 엔드포인트를 테스트하세요. 원하는 엔드포인트를 클릭하고 매개변수를 추가한 후 요청을 보내 실제 응답을 확인할 수 있습니다.

• 문서를 팀과 공유하거나 공개하세요. 편집 또는 보기 권한을 설정하여 접근을 제어할 수 있습니다.

• OpenAPI 파일로부터 아름다운 API 문서화

• 내장된 API 클라이언트 테스트

• GitHub 통합 및 자동 동기화

• 맞춤 도메인 및 테마

• 모든 주요 플랫폼을 위한 프레임워크 통합

• TypeSense 기반 검색

• 여러 API 버전 지원

• Markdown 및 MDX 가이드

• 팀 협업 도구

• 오픈 소스 및 자체 호스팅 가능

• 무료 서브도메인 포함

• 맞춤 CSS 및 JavaScript 지원