Repolode
제출하기
swagger-api

swagger-api/swagger-ui

OpenAPI 사양 파일을 바탕으로 브라우저에서 대화형 API 문서를 생성합니다.

대체할 수 있는 제품:PostmanReadMe

GitHub에서 보기웹사이트
스타
29,040
포크
9,250
열린 이슈
1,144
마지막 커밋
3일 전

어떤 프로젝트인가요?

Swagger UI는 OpenAPI(이전 명칭 Swagger) 사양을 탐색 가능한 문서 페이지로 렌더링하는 HTML, JavaScript, CSS 에셋 모음입니다. 개발자와 API 사용자는 모든 엔드포인트와 매개변수, 응답 형식을 확인하고, 클라이언트 코드를 먼저 작성하지 않아도 페이지에서 직접 테스트 요청을 보낼 수 있습니다.

이 프로젝트는 세 가지 형태로 배포됩니다. 번들러를 사용하는 단일 페이지 앱용 swagger-ui npm 모듈, npm 의존성을 해결할 수 없는 서버나 앱을 위한 의존성 없는 번들 swagger-ui-dist, 그리고 React 컴포넌트인 swagger-ui-react입니다. dist 폴더의 일반 HTML, JS, CSS 파일을 웹 서버 어디에나 복사해 사용할 수도 있습니다.

현재 릴리스는 OpenAPI 2.0부터 3.2.0까지와 여러 3.x 마이너 버전을 지원합니다. 최신 버전의 Chrome, Safari, Firefox, Edge에서 실행됩니다.

핵심 기능

  • 01OpenAPI 및 Swagger 사양을 대화형 문서 페이지로 렌더링합니다.
  • 02브라우저에서 직접 엔드포인트에 테스트 요청을 보낼 수 있습니다.
  • 03npm 모듈, 의존성 없는 dist 번들, React 컴포넌트 형태로 제공됩니다.
  • 04OAuth2 인증과 특정 작업으로 이동하는 딥 링크를 지원합니다.
  • 05설정, 플러그인 API, 사용자 정의 레이아웃으로 구성할 수 있습니다.

활용 사례

  • 백엔드 서비스의 API 레퍼런스 문서를 게시해 내부 또는 외부 사용자가 이용하도록 합니다.
  • 프런트엔드 및 모바일 팀이 클라이언트 코드를 작성하기 전에 API를 살펴볼 수 있게 합니다.
  • React 애플리케이션에 대화형 API 문서를 삽입합니다.
  • npm 의존성을 설치할 수 없는 서버에서 정적 API 문서를 제공합니다.

토픽

#openapi#swagger#api-documentation#rest-api#javascript#api-testing#hacktoberfest#oas#open-source#openapi-specification

자주 묻는 질문

swagger-ui은(는) 무엇인가요?
OpenAPI 사양 파일을 바탕으로 브라우저에서 대화형 API 문서를 생성합니다. Swagger UI는 OpenAPI(이전 명칭 Swagger) 사양을 탐색 가능한 문서 페이지로 렌더링하는 HTML, JavaScript, CSS 에셋 모음입니다. 개발자와 API 사용자는 모든 엔드포인트와 매개변수, 응답 형식을 확인하고, 클라이언트 코드를 먼저 작성하지 않아도 페이지에서 직접 테스트 요청을 보낼 수 있습니다.
swagger-ui은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?
swagger-ui은(는) Apache-2.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.
swagger-ui은(는) 아직 유지보수되고 있나요?
활발히 유지보수 중. swagger-ui의 마지막 커밋은 2026년 10월 16일입니다.
swagger-ui은(는) 어디에 사용할 수 있나요?
백엔드 서비스의 API 레퍼런스 문서를 게시해 내부 또는 외부 사용자가 이용하도록 합니다. 프런트엔드 및 모바일 팀이 클라이언트 코드를 작성하기 전에 API를 살펴볼 수 있게 합니다. React 애플리케이션에 대화형 API 문서를 삽입합니다. npm 의존성을 설치할 수 없는 서버에서 정적 API 문서를 제공합니다.
swagger-ui은(는) 어디서 받을 수 있나요?
소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/swagger-api/swagger-ui

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

관련 프로젝트