참고: 응답 및 요청 본문의 예제는 자유 형식이지만 본문 스키마와 호환될 것으로 예상됩니다. 우리의 /로그인 API는 콜백 URL을 사용, 일부 사용자 로그인 하는 경우, 우리는 적절 한 데이터와 그 콜백 URL을 호출 하 고 로그인 이벤트에 대 한 정보를 알려야 한다. 이 예제는 데모용입니다. 여기에서 콜백 섹션 내에서 loginEvent라는 임의의 이벤트 이름을 정의합니다. 이벤트는 호출할 호출 URL을 정의합니다. {$request.body#/callback/url}은 요청 본문에 콜백이라는 섹션이 있음을 의미합니다. 이 식은 런타임에 평가되며 해당 키를 통해 요청 본문에 전달된 실제 콜백 URL을 검색합니다. 콜백 URL 아래의 게시물 섹션에서는 콜백 URL을 호출하기 위해 요청 본문을 형성하는 방법을 설명합니다. 개방형 API(공용 API라고도 함)는 개발자에게 독점 소프트웨어 응용 프로그램 또는 웹 서비스에 대한 프로그래밍 방식으로 액세스할 수 있는 공개적으로 사용할 수 있는 응용 프로그램 프로그래밍 인터페이스입니다. [1] [2] API는 한 응용 프로그램이 다른 응용 프로그램과 통신하고 상호 작용하는 방법을 제어하는 요구 사항 집합입니다. API는 개발자가 프로그램의 특정 내부 기능에 액세스할 수 있도록 허용할 수도 있지만 일반적으로 웹 API의 경우는 아닙니다. 간단히 말해서 API를 사용하면 운영 체제에서 제공하는 메커니즘을 통해 단일 컴퓨터 내에서든 내부 또는 외부 TCP/IP 기반 또는 비 TCP/IP 기반 네트워크를 통해 단일 컴퓨터 내에서 소프트웨어의 한 조각이 다른 소프트웨어와 상호 작용할 수 있습니다.
[3] 2010년대 후반에는 조직에서 HTTP에 액세스하기 위해 많은 API를 제공합니다. API를 게시한 조직 내의 개발자 나 인터페이스에 대한 액세스를 등록하려는 조직 외부의 개발자가 API를 사용할 수 있습니다. 사양의 구성 요소/예제 섹션에서 일반적인 예제를 정의한 다음 다양한 매개 변수 설명, 요청 및 응답 본문 설명, 개체 및 proeprties에서 다시 사용할 수 있습니다. JSON 또는 YAML 형식에서 문자열로 지정: 매개 변수, 속성 및 개체에 예제를 추가하여 웹 서비스의 OpenAPI 사양을 더 명확하게 만들 수 있습니다. 예를 들어 API를 어떤 식으로든 처리하는 도구와 라이브러리에서 읽을 수 있습니다. 예를 들어 API 모의 도구는 샘플 값을 사용하여 모의 요청을 생성할 수 있습니다. 개체, 개별 속성 및 작업 매개 변수에 대한 예제를 지정할 수 있습니다.