Transformações na exportação
Ao exportar uma definição projetada com os recursos do API Designer em um formato que não os suporta, a definição é modificada para se adequar ao formato de destino. Alguma expressividade é perdida no processo.
A tabela abaixo descreve as modificações feitas na sua definição de API ao exportar em uma das seguintes especificações:
- OAS/Swagger 2.0
- Swagger 1.2
- RAML 1.0
| Recurso não permitido | Transformação |
|---|---|
| Componentes | O componente é copiado em todos os lugares onde é usado. |
| Intervalos de resposta e respostas padrão | A resposta é removida. |
| Autenticação Bearer e OpenID Connect | O esquema de segurança é removido. |
| Combinações de allOf | A combinação é substituída por um objeto contendo todas as propriedades de todos os tipos usados. |
| Combinações anyOf e oneOf | A combinação é substituída por um objeto vazio. |
| Múltiplos endpoints | O primeiro endpoint publicado é incluído na definição, os outros são ignorados. |
A OpenAPI Specification 3.0 só aceita URLs no campo Termos de serviço. Ao exportar uma definição na OAS 3.0, esse campo é exportado somente se contiver uma URL. Caso contrário, o campo Termos de serviço é ignorado para garantir a validade da definição.