swagger ui

소개

Swagger UI를 사용하면 개발 팀 또는 최종 소비자 등 모든 사람이 구현 논리를 제자리에 두지 않고 API 리소스를 시각화하고 상호 작용할 수 있습니다. OpenAPI (이전의 Swagger라고도 함) 사양에서 자동으로 생성되며 시각적 문서를 통해 백엔드 구현 및 클라이언트 측 소비가 쉽습니다.

일반적인

? 쉬운 오픈 소스 기부금을 득점하고 싶습니까? 좋은 첫 번째 이슈 레이블을 확인하십시오.

? ️ Swagger UI의 이전 버전을 찾고 계십니까? 2.x 브랜치를 참조하십시오.

이 저장소는 세 가지 NPM 모듈을 게시합니다.

• Swagger-UI는 종속성을 해결할 수있는 단일 페이지 애플리케이션에 사용하기위한 기존의 NPM 모듈입니다 (웹 팩, 브라우저 화 등).
• Swagger-UI-Dist는 서버 측 프로젝트에서 Swagger UI를 제공하는 데 필요한 모든 것을 포함하는 종속성없는 모듈 또는 NPM 모듈 종속성을 해결할 수없는 단일 페이지 응용 프로그램입니다.
• Swagger-UI-React는 Swagger UI가 React 응용 프로그램에 사용하기위한 React 구성 요소로 포장됩니다.

swagger-ui swagger-ui-dist 가 훨씬 더 크기 때문에 단일 페이지 응용 프로그램을 구축하는 경우 swagger-ui-dist 대신 Swagger-UI를 사용하는 것이 좋습니다.

일반 OL 'HTML/JS/CSS를 찾고 있다면 최신 릴리스를 다운로드하여 /dist 폴더의 내용을 서버에 복사하십시오.

호환성

OpenAPI 사양은 2010 년 초기 생성 이후 5 건의 개정을 거쳤습니다. Swagger UI와 OpenAPI 사양 간의 호환성은 다음과 같습니다.

Swagger UI 버전	출시일	OpenApi 사양 호환성	메모
5.0.0	2023-06-12	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0	태그 v5.0.0
4.0.0	2021-11-03	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3	태그 v4.0.0
3.18.3	2018-08-03	2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3	태그 v3.18.3
3.0.21	2017-07-26	2.0	태그 v3.0.21
2.2.10	2017-01-04	1.1, 1.2, 2.0	태그 v2.2.10
2.1.5	2016-07-20	1.1, 1.2, 2.0	태그 v2.1.5
2.0.24	2014-09-12	1.1, 1.2	태그 v2.0.24
1.0.13	2013-03-08	1.1, 1.2	태그 v1.0.13
1.0.1	2011-10-11	1.0, 1.1	태그 v1.0.1

익명 분석

Swaggerui는 Scarf를 사용하여 익명화 된 설치 분석을 수집합니다. 이 분석은이 라이브러리의 관리자를 지원하고 설치 중에 만 실행하는 데 도움이됩니다. 옵트 아웃하려면 scarfSettings.enabled 필드를 프로젝트의 package.json 에서 false 로 설정할 수 있습니다.

 // package.json
{
  // ...
  "scarfSettings": {
    "enabled": false
  }
  // ...
}

또는 NPM 패키지를 설치하는 환경의 일부로 환경 가변 SCARF_ANALYTICS false 로 설정할 수 있습니다 (예 : SCARF_ANALYTICS=false npm install .

선적 서류 비치

용법

• 설치
• 구성
• 코스
• oauth2
• 깊은 연결
• 제한
• 버전 감지

사용자 정의

• 개요
• 플러그인 API
• 맞춤형 레이아웃

개발

• 설정
• 스크립트

기여

• 기여

통합 테스트

여기에서 지시에 따라 https://nightwatchjs.org/guide/getting-started/installation.html#install-selenium-server

npm run e2e 사용하여 통합 테스트를 로컬로 실행할 수 있습니다. 테스트 할 때 DEV 서버를 실행하지 않아야합니다!

브라우저 지원

Swagger UI는 Chrome, Safari, Firefox 및 Edge의 최신 버전에서 작동합니다.

알려진 문제

마이그레이션을 돕기 위해 현재 3.x에서 알려진 문제는 다음과 같습니다. 이 목록은 정기적으로 업데이트되며 이전 버전에서 구현되지 않은 기능은 포함되지 않습니다.

• 이전에 지원 된 매개 변수의 일부만 사용할 수 있습니다.
• JSON 양식 편집기는 구현되지 않았습니다.
• collectionFormat 에 대한 지원은 부분적입니다.
• L10N (Translations)은 구현되지 않았습니다.
• 외부 파일에 대한 상대 경로 지원은 구현되지 않았습니다.

보안 연락처

공개 이슈 추적기를 사용하는 대신 [email protected]를 이메일로 보내 보안 관련 문제 또는 취약점을 공개하십시오.

특허

Swaggerui는 Apache 2.0 라이센스에 따라 라이센스가 부여됩니다. Swaggerui에는 추가 법적 통지 및 정보가 포함 된 명시 적 통지 파일이 제공됩니다.