redoc은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

redoc은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

redoc은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. redoc의 마지막 커밋은 2026년 10월 20일입니다.

redoc은(는) 어디에 사용할 수 있나요?

OpenAPI 파일을 바탕으로 공개 API 레퍼런스 문서 게시 기존 React 또는 정적 HTML 사이트에 API 문서 삽입 오프라인 사용이나 내부 공유를 위한 독립형 HTML 파일 생성

redoc는 어떻게 설치하나요?

npx로 OpenAPI 파일에서 문서를 생성합니다(Node 필요).: npx @redocly/cli build-docs openapi.yaml 생성된 redoc-static.html 파일을 브라우저에서 엽니다.

redoc은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/Redocly/redoc

Redocly/redoc

OpenAPI, Swagger, AsyncAPI 또는 GraphQL 정의로 반응형 3단 API 레퍼런스 사이트를 생성하는 오픈소스 도구입니다.

대체할 수 있는 제품:SwaggerUI

GitHub에서 보기 웹사이트

스타: 25,970
포크: 2,404
열린 이슈: 366
마지막 커밋: 10시간 전

어떤 프로젝트인가요?

Redoc은 API 정의 파일을 탐색 가능한 문서 페이지로 변환합니다. OpenAPI 3.2, 3.1, 3.0, Swagger 2.0을 지원하며, AsyncAPI 3.x와 GraphQL SDL도 처리하고 형식을 자동으로 감지합니다. 기본 레이아웃은 3개 패널로 구성됩니다. 왼쪽에는 검색창과 탐색 메뉴, 중앙에는 문서, 오른쪽에는 요청 및 응답 예제가 표시됩니다.

Redoc은 여러 방식으로 사용할 수 있습니다. npx를 사용해 Redocly CLI로 정적 HTML 파일을 만들거나, 스펙 URL을 불러오는 커스텀 요소를 HTML 페이지에 삽입하거나, React 컴포넌트로 렌더링할 수 있습니다. CSS 변수로 테마를 설정할 수 있고 다크 모드를 지원하며, x-logo, x-tagGroups, x-codeSamples 등의 OpenAPI 확장 필드를 읽어 출력 내용을 맞춤 설정할 수 있습니다.

이 프로젝트는 Redocly가 유지 관리하며, 호스팅형 상용 버전에는 try-it 패널, 모의 서버, 린팅 등의 기능이 추가됩니다.

핵심 기능

01OpenAPI 3.2/3.1/3.0 및 Swagger 2.0 정의 렌더링
02AsyncAPI 3.x와 GraphQL SDL 지원 및 형식 자동 감지
03탐색 메뉴가 동기화되는 반응형 3단 레이아웃
04CSS 변수를 통한 다크 모드 및 테마 설정
05HTML 태그, React 컴포넌트, Redocly CLI 명령어 및 Docker 이미지로 제공

활용 사례

OpenAPI 파일을 바탕으로 공개 API 레퍼런스 문서 게시
기존 React 또는 정적 HTML 사이트에 API 문서 삽입
오프라인 사용이나 내부 공유를 위한 독립형 HTML 파일 생성

빠른 시작

1
npx로 OpenAPI 파일에서 문서를 생성합니다(Node 필요).
npx @redocly/cli build-docs openapi.yaml
2
생성된 redoc-static.html 파일을 브라우저에서 엽니다.

사용 전 알아둘 점

Community Edition에는 Try-it 패널, 모의 서버, SOAP 지원 등의 기능이 없습니다. 이러한 기능은 호스팅 Redoc 제품에서만 제공됩니다.
Redoc은 기본적으로 익명 사용량 및 성능 데이터를 수집하므로, 수집을 거부하려면 disable-telemetry 또는 disableTelemetry를 설정해야 합니다.

토픽

#api-documentation #openapi #swagger #documentation-generator #asyncapi #graphql #react #documentation-tool #hacktoberfest #openapi-specification

자주 묻는 질문

redoc은(는) 무엇인가요?: OpenAPI, Swagger, AsyncAPI 또는 GraphQL 정의로 반응형 3단 API 레퍼런스 사이트를 생성하는 오픈소스 도구입니다. Redoc은 API 정의 파일을 탐색 가능한 문서 페이지로 변환합니다. OpenAPI 3.2, 3.1, 3.0, Swagger 2.0을 지원하며, AsyncAPI 3.x와 GraphQL SDL도 처리하고 형식을 자동으로 감지합니다. 기본 레이아웃은 3개 패널로 구성됩니다. 왼쪽에는 검색창과 탐색 메뉴, 중앙에는 문서, 오른쪽에는 요청 및 응답 예제가 표시됩니다.
redoc은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?: redoc은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
redoc은(는) 아직 유지보수되고 있나요?: 활발히 유지보수 중. redoc의 마지막 커밋은 2026년 10월 20일입니다.
redoc은(는) 어디에 사용할 수 있나요?: OpenAPI 파일을 바탕으로 공개 API 레퍼런스 문서 게시 기존 React 또는 정적 HTML 사이트에 API 문서 삽입 오프라인 사용이나 내부 공유를 위한 독립형 HTML 파일 생성
redoc는 어떻게 설치하나요?: npx로 OpenAPI 파일에서 문서를 생성합니다(Node 필요).: npx @redocly/cli build-docs openapi.yaml 생성된 redoc-static.html 파일을 브라우저에서 엽니다.
redoc은(는) 어디서 받을 수 있나요?: 소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/Redocly/redoc

요약은 프로젝트 README를 바탕으로 AI가 작성했습니다. GitHub 통계는 매일 갱신됩니다.