이전에 Swagger Specification으로 알려진 OpenAPI Specification은 RESTful 웹 서비스를 설명, 생성, 사용, 시각화하기 위한 기계 판독 가능한 인터페이스 파일에 대한 사양이에요. 이전에는 Swagger 프레임워크의 일부였지만, 2016년에 Linux Foundation의 오픈 소스 협력 프로젝트인 OpenAPI Initiative가 감독하는 별도의 프로젝트가 됐어요. Swagger와 몇몇 다른 도구는 인터페이스 파일이 주어지면 코드, 문서, 테스트 케이스를 생성할 수 있어요.
OpenAPI 인터페이스 파일을 기반으로 구현된 애플리케이션은 메서드, 매개변수, 모델의 문서를 자동으로 생성할 수 있어요. 이를 통해 문서, 클라이언트 라이브러리, 소스 코드의 동기화를 유지할 수 있어요.
새로운 OpenAPI WebService가 출시됐어요(현재 BETA). 이 서비스는 JSON 형식의 OpenAPI 3.0 Specification을 읽고 네이티브 Pascal 코드로 Delphi 클라이언트를 자동으로 생성해요. WebService는 API와 상호작용하는 방법을 보여주는 데모를 만들어요.
WebService는 사양이 3.0+이고 JSON 형식이어야 해요.
OpenAPI Specification 가져오기
첫 번째 단계는 openAPI 3.0 사양을 가져오는 거예요. 이를 위해 abstractapi.com에서 IP 주소의 위치를 검색하는 데 사용하는 간단한 openAPI 사양을 사용할 거예요. 아래에서 사양 파일을 확인하세요:
JSON 형식의 openAPI 3.0 사양이 준비되면, OpenAPI WebService를 사용해 필요한 Delphi 파일을 생성할 수 있어요. 다음 URL로 이동하세요:
https://www.esegece.com/products/openapi/ws/demo
클래스 이름(기본값은 TsgcOpenAPI_Test)을 설정하고 사양 파일을 업로드하기만 하면 돼요(먼저 압축을 풀어주세요!!!, JSON 형식이어야 해요). 마지막으로 Upload 버튼을 눌러 파일을 처리하세요.
처리가 성공하면, 빌드된 데모가 포함된 새 압축 파일이 다운로드돼요.
openAPI 데모 테스트
데모를 테스트하기 전에, API 키를 얻으려면 abstractapi.com에서 무료 계정을 만들어야 해요.
https://app.abstractapi.com/users/signup
다운로드한 파일의 압축을 풀고 Demo 폴더로 이동하면 sgcOpenAPIDemo.exe 파일을 찾을 수 있어요. 실행하세요.
새 폼이 표시되며 Abstractapi.com의 URL을 보여줘요.
다음 버튼을 누르고 Retrieve_the_location_of_an_IP_address 메서드를 선택한 다음, 검색할 Api_Key와 IP Address를 입력하세요. 요청이 성공적으로 처리되면 IP 주소에 대한 정보가 포함된 JSON 메시지가 반환돼요.
아래에서 테스트를 수행하기 위해 sgcOpenAPI WebService가 자동으로 생성한 압축 파일을 확인하세요.