Skip to content

OpenAPI (Swagger) 지원

Swagger 도구의 강력함은 OpenAPI 사양에서 시작되며, 이는 RESTful API 설계의 업계 표준입니다

Swagger 개요

Swagger는 OpenAPI 사양을 최대한 활용하기 위한 가장 강력하고 사용하기 쉬운 도구를 제공합니다. 이러한 도구는 REST API를 설계, 구축, 문서화 및 사용하는 데 도움이 될 수 있습니다.

OpenAPI 개요

OpenAPI 사양(이전의 Swagger 사양)은 REST API를 위한 API 설명 형식입니다. OpenAPI 파일을 사용하면 다음을 포함하여 전체 API를 설명할 수 있습니다.

  • 사용 가능한 엔드포인트(/users) 및 각 엔드포인트의 작업(GET /users, POST /users)

엔드포인트 구성

  • 작업 매개변수 각 작업의 입력 및 출력

엔드포인트 매개변수/앱 설정

  • 인증 방법
  • 연락처 정보, 라이선스, 이용 약관 및 기타 정보

API 사양은 YAML 또는 JSON으로 작성할 수 있습니다. 이 형식은 배우기 쉽고 사람과 기계 모두 읽을 수 있습니다. 전체 OpenAPI 사양은 GitHub에서 확인할 수 있습니다: OpenAPI 3.0 Specification. OpenAPI에 대한 자세한 정보는 여기를 참조하세요.

Swagger 데모

Swagger 정의 지정

이 시점에서 Swagger 파일 URL(json/yaml)을 지정하거나 _정의 업로드_를 할 수 있습니다. 로드된 후 _엔드포인트 구성_이 나타납니다.

엔드포인트 구성 대화 상자의 왼쪽에는 다음이 포함됩니다.

  • 기본 URL - 파일 정의에 값이 있는 경우 자동으로 채워질 수 있습니다
  • 권한 부여 - 필요한 경우 인증 키를 제공합니다
  • 엔드포인트 트리 보기 - 모든 사용 가능한 엔드포인트가 해당 유형(GET, PUT, POST 등)과 함께 로드됩니다

엔드포인트 구성 대화 상자의 오른쪽에는 다음이 포함됩니다.

  • 선택하기 전에 연결을 테스트하는 데 사용할 수 있는 전송 버튼이 있는 요청 URL
  • 권한 부여, 매개변수 및 헤더에 대한 탭 요소 - 필요한 경우 표시됩니다.
  • 정보 메시지 또는 필수 필드를 표시하는 탭 콘텐츠 섹션입니다. 예제 이미지:

엔드포인트 구성 대화 상자

로컬 네트워크 소스에서 데이터 소스 사용

이제 localhost 또는 프라이빗 네트워크에 요청할 수 있습니다. 자세한 정보는 애플리케이션에서 데이터 사용 항목의 프라이빗 네트워크 사용 섹션 부분을 참조하세요

로컬 네트워크 소스 사용

추가 리소스