OpenAPI 3.x란?

OpenAPI는 RESTful API를 설명하는 업계 표준 사양이에요. 이전에는 Swagger로 알려졌으며 자동화된 코드 생성, 문서화, 테스트를 가능하게 해요.

API 표준

OpenAPI는 HTTP API를 설명하는 기계 판독 가능한 형식을 제공해 도구가 코드, 문서, 테스트 스위트를 자동으로 생성할 수 있게 해요.

Swagger 기원

Swagger 1.x와 2.x는 API 설명 형식의 토대를 구축했어요. 2015년 OpenAPI Initiative에 사양이 기증됐고 OpenAPI 3.x로 발전했어요.

OpenAPI 3.x

현재 표준은 JSON 및 YAML 형식, 고급 스키마 정의, 다중 인증 스킴, 웹훅, 작업 간 링크를 지원해요.

Delphi 통합

sgcOpenAPI는 모든 OpenAPI 또는 Swagger 사양을 파싱하고 네이티브 Object Pascal 코드를 생성해요. Delphi 개발자에게 최고 수준의 API 도구를 제공해요.

사양이 설명하는 것

엔드포인트 및 작업

경로, HTTP 메서드(GET, POST, PUT, DELETE), 쿼리 매개변수, 헤더, 요청 본문이 모두 구조화된 형식으로 정의돼요.

스키마 및 모델

데이터 유형, 객체 속성, 배열, 열거형, 컴포지션(allOf, oneOf, anyOf)이 요청 및 응답 페이로드의 구조를 설명해요.

인증

API 키, OAuth 2.0 흐름, HTTP Bearer 토큰, OpenID Connect가 작업에 적용되는 재사용 가능한 보안 스킴으로 정의돼요.

Delphi에서 OpenAPI 활용하기

모든 OpenAPI 사양에서 네이티브 Pascal SDK를 생성하세요.