API 및 애플리케이션 작성

개발자 툴킷을 사용하여 API 프록시 및 API 구현을 개발할 수 있습니다. 문서에서 API는 API 프록시를 말하고, application은 API 구현을 말합니다.

개발자 툴 킷을 사용하면 OpenAPI 를 통해 기존 백엔드 구현을 프록시하여 언어에 구애받지 않는 API를 생성하거나, Express®, Java™, Swift, Go 등 다른 언어나 프레임워크로 개발된 애플리케이션을 확장할 수 있습니다.

개발 아티팩트 정의 작성

apic create 명령을 통해 다음 명령을 사용하여 개발 아티팩트를 작성합니다.

표 1. 참고 정보
명령	설명
`apic create:api`	OpenAPI 정의를 작성하십시오.
`apic create:api --wsdl filename`	서비스의 WSDL 정의 파일을 포함하는 .zip 파일 또는 WSDL 정의 파일에서 SOAP API 정의를 작성합니다. 생성된 API의 이름 및 버전은 WSDL 파일에서 얻습니다. .zip 파일을 업로드하는 경우 추가 지시문을 지정하기 위한 옵션 파일을 .zip 파일에 포함할 수 있습니다. 자세한 내용은 ‘WSDL 서비스 가져오기 시 옵션 파일 사용’을 참조하십시오.
`apic create:product`	API 제품 정의를 작성합니다.

참고: --template template-name 옵션을 사용하여 OpenAPI 템플리트 파일에서 API 또는 제품을 작성할 수 있습니다.

--title 옵션을 제공하여 비대화식으로 제품 및 API 정의를 작성할 수도 있습니다. 이 옵션은 추가 옵션으로 사용자 정의할 수도 있는 여러 값을 설정합니다. 예를 들어, 다음과 같습니다.

apic create:api --title Routes
apic create:product --title "Climb On"

또한 API 및 제품 정의를 동시에 작성할 수 있습니다.

apic create:api --title Routes --product "Climb On"
apic create:api --wsdl globalweather.wsdl --product "Weather Forecasting"

또는 API를 작성하고 새 제품을 작성할 때 이를 참조할 수 있습니다. 예를 들어, 다음과 같습니다.

apic create:api --title Routes
apic create:api --title Ascents
apic create:product --title "Climb On" --apis "routes.yaml ascents.yaml"

개발 아티팩트 정의 유효성 검증

개발 아티팩트를 편집한 후 또는 아티팩트를 공개하기 전에 이들을 유효성 검증하는 것이 우수 사례입니다. 예를 들어, 다음과 같습니다.

apic validate routes.yaml                      # Validate an API
apic validate climb-on.yaml                    # Validate the Product and its APIs
apic validate climb-on.yaml --product-only     # Validate the Product only (do not validate the referenced APIs)

참고: API를 정의하는 OpenAPI 파일이 $ref 필드를 사용하여 별도의 파일에 정의된 OpenAPI 코드의 단편을 참조하는 경우드래프트 API가 apic drafts:validate 명령으로 작성되기 전에 $ref 필드가 대상 파일의 컨텐츠로 대체됩니다. 자세한 정보는 $ref를 사용하여 OpenAPI 파일에서 코드 단편 재사용을 참조하십시오.