Creación de APIs y aplicaciones

Puede desarrollar proxies de API e implementaciones de API utilizando el kit de herramientas del desarrollador. En la documentación, API hace referencia al proxy de API y aplicación hace referencia a la implementación de API.

Puede utilizar el kit de herramientas para desarrolladores para crear API independientes del lenguaje mediante el uso de OpenAPI como proxy a una implementación de backend existente o para aumentar las aplicaciones que se desarrollan en otros lenguajes o marcos como Express, Java™, Swift, Go y otros.

Creación de definiciones de artefacto de desarrollo

Utilice el mandato apic create para crear artefactos de desarrollo mediante los mandatos siguientes:

Mandato	Descripción
`apic create:api`	Cree una definición de OpenAPI .
`apic create:api --wsdl filename`	Crear una definición API SOAP a partir de un archivo WSDL o un archivo .zip que contiene los archivos de definición WSDL para un servicio. El nombre y la versión de la API generada se obtienen del archivo WSDL. Si carga un archivo .zip, puede incluir en el archivo .zip un archivo de opciones para especificar directivas adicionales. Para obtener detalles, consulte Utilización de un archivo de opciones al importar un servicio WSDL.
`apic create:product`	Crear una definición de producto de API.

Nota: Puede crear una API o un producto a partir de un archivo de plantilla OpenAPI utilizando la opción --template template-name .

También puede crear definiciones de producto y API que no sean interactivas proporcionando la opción --title. Esta opción establece varios valores que también puede personalizar con opciones adicionales, por ejemplo:

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

También puede crear las definiciones de API y de producto a la vez:

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

También puede crear APIs y hacer referencia a ellas cuando crea un producto nuevo; por ejemplo:

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

Validación de definiciones de artefacto de desarrollo

Después de editar artefactos de desarrollo o antes de publicar artefactos, el procedimiento recomendado es validarlos; por ejemplo:

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)

Nota: Si el archivo OpenAPI que define la API utiliza un campo $ref para hacer referencia a un fragmento de código OpenAPI definido en un archivo aparte,el campo $ref se sustituye por el contenido del archivo de destino antes de que se cree el borrador de API con el mandato apic drafts:validate . Para obtener más información, consulte Utilización de $ref para reutilizar fragmentos de código en los archivos OpenAPI.