Suporte à OpenAPI Specification 3.0 | Qlik Cloud Ajuda
Ir para conteúdo principal Pular para conteúdo complementar
Recursos da Qlik
Carregando a pesquisa do SearchUnify Se precisar de assistência com seu produto, entre em contato com o Suporte Qlik.
Qlik Customer Portal
Carregando a pesquisa do SearchUnify Se precisar de assistência com seu produto, entre em contato com o Suporte Qlik.
Qlik Customer Portal

Suporte à OpenAPI Specification 3.0

Crie uma API com a OpenAPI Specification (OAS) 3.0 usando o API Designer.

A OpenAPI Specification 3.0 vem com novos recursos, trazendo mais expressividade e produtividade para os designers de API.

Para obter mais informações sobre a OpenAPI, consulte a Documentação do Swagger.

Componentes

Os componentes permitem reutilizar vários elementos em uma API. Esses elementos podem ser:
  • Variáveis de caminho
  • Parâmetros de consulta
  • Cabeçalhos
  • Respostas

Combinações

Combinações permitem criar um novo tipo de dados combinando vários outros tipos de dados. O API Designer permite dois tipos de combinações:
  • A composição (allOf) permite agregar propriedades de esquema de diferentes esquemas. Por exemplo, você pode definir um tipo de dados Empresa reutilizando todas as propriedades dos tipos existentes Contato e Erro.
    Exemplo de composição.
  • O polimorfismo (oneOf /anyOf) permite criar uma entidade que pode usar as propriedades de diferentes tipos de dados.
    • oneOf permite definir um tipo de dados contendo as propriedades de um dos tipos selecionados. Por exemplo, se você criar uma operação para obter informações sobre uma conta de serviço, você pode definir a resposta usando a combinação oneOf para obter todas as propriedades de Erro ou todas as propriedades de ServiceAccountCount.
      Exemplo de polimorfismo.
    • anyOf permite definir um tipo de dados que contenha as propriedades de um ou mais dos tipos selecionados. Por exemplo, você pode definir um tipo de dados nervousSystem e um tipo skeleton contendo propriedades diferentes, e usar a combinação anyOf para criar um tipo de dados contendo quaisquer propriedades de qualquer um desses tipos.

      Uma combinação anyOf é válida desde que contenha todos os parâmetros necessários de pelo menos um dos tipos de dados selecionados. O exemplo abaixo usa a propriedade brain_weight do tipo nervousSystem e as propriedades skull_height e teeth de skeleton.

      Exemplo de combinação usando os tipos de dados nervousSystem e skeleton.

Para obter mais informações sobre composição e polimorfismo, consulte Herança e Polimorfismo e Diferença entre anyOf e oneOf.

Respostas

A OAS 3.0 permite definir novos tipos de respostas para suas operações:
  • Intervalos de resposta: em vez de definir uma resposta como 200, você pode defini-la como 2XX, para que inclua respostas de 200 para 299.
  • Respostas padrão: você pode definir uma resposta padrão a ser retornada quando uma resposta específica ou de intervalo não for definida.
As respostas definidas com um código explícito têm precedência sobre os intervalos de resposta e as respostas padrão, e os intervalos de resposta têm precedência sobre as respostas padrão. No exemplo a seguir:
  • O 204 A resposta é definida e tem precedência sobre as outras.
  • O 2XX A resposta aplica-se aos códigos de resposta de 200 a 203 e de 205 a 299.
  • O padrão A resposta aplica-se a todas as respostas 1XX, 3XX, 4XX e 5XX.
Seção Respostas.

Segurança

A OAS 3.0 traz novos esquemas de segurança para sua API:
  • Autenticação por portador
  • OpenIdConnect

Restrições

A OAS 3.0 permite indicar que algumas propriedades são somente leitura ou somente gravação.

Esta opção está disponível somente em tipos de dados e não pode ser definida em solicitações ou respostas no nível da operação.

Exemplo de restrição.

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo – um erro de digitação, uma etapa ausente ou um erro técnico – avise-nos!

Deixe seu feedback aqui