Criando APIs e aplicativos

É possível desenvolver proxies e implementações de API usando o kit de ferramentas do desenvolvedor. Na documentação, API refere-se ao proxy de API e application refere-se à implementação de API.

Você pode usar o kit de ferramentas do desenvolvedor para criar APIs independentes de linguagem usando OpenAPI para fazer proxy para uma implementação de back-end existente ou para aumentar os aplicativos desenvolvidos em outras linguagens ou estruturas, como Express, Java™, Swift, Go e outras.

Criando definições de artefato de desenvolvimento

Use o comando apic create para criar artefatos de desenvolvimento, usando os comandos a seguir:

Comando	Descrição
`apic create:api`	Crie uma definição OpenAPI .
`apic create:api --wsdl filename`	Criar uma definição da API SOAP de um arquivo de definição WSDL ou de um arquivo .zip que contenha os arquivos de definição WSDL para um serviço. O nome e a versão da API gerada são obtidos do arquivo WSDL. Se fizer upload de um arquivo .zip, será possível incluir no arquivo .zip um arquivo de opções para especificar diretivas adicionais. Para obter detalhes, consulte Usando um arquivo de opções ao importar um serviço WSDL..
`apic create:product`	Criar uma definição de produto de API.

Nota: é possível criar uma API ou Produto a partir de um arquivo de modelo OpenAPI usando a opção --template template-name .

Também é possível criar definições de Produto e API não interativamente, fornecendo a opção --title. Essa opção configura vários valores que também podem ser customizados com opções adicionais; por exemplo:

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

Também é possível criar as definições de API e Produto ao mesmo tempo:

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

Como alternativa, é possível criar APIs e, depois, referenciá-las ao criar um novo Produto; por exemplo:

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

Validando definições de artefato de desenvolvimento

Depois de editar artefatos de desenvolvimento ou antes de publicar artefatos, a melhor prática é validá-los, por exemplo:

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: Se o arquivo OpenAPI que define sua API usar um campo $ref para fazer referência a um fragmento de OpenAPI código definido em um arquivo separado,o campo $ref será substituído pelo conteúdo do arquivo de destino antes que a API de rascunho seja criada com o comando apic drafts:validate . Para obter mais informações, consulte Usando $ref para reutilizar fragmentos de código em seus arquivos OpenAPI..