Subir e atualizar um spec OpenAPI
Uma simulação serve a sua própria API a partir do spec OpenAPI dela. YAML e JSON funcionam, OpenAPI 3.0 e 3.1. Swagger 2.0 não é suportado; converta para OpenAPI 3 antes. Spec com referência circular não é problema: a geração detecta o ciclo e lida com ele.
Subir um spec
Na simulação, abra Endpoints, clique em Adicionar e escolha Spec OpenAPI. Solte o arquivo ou procure ele, e depois escolha o caminho de montagem; o diálogo mostra a URL em que o seu spec vai responder.
Clique em Adicionar spec e depois faça o deploy para colocar no ar.
O limite de tamanho
Um arquivo de spec pode ter até 4 MB. É um limite flexível: se o seu spec for maior, divida em vários, ou fale com a gente e dá para aumentar para a sua organização.
As simulações codegen não têm limite de upload, porque não tem upload: o código é gerado a partir do seu spec dentro do seu repositório, e o spec em si nunca chega até a gente.
Veja Simulações codegen.
Specs grandes
Um spec grande pesa mais para servir: usa mais memória e sobe mais devagar que um pequeno.
Duas opções por serviço ajudam, em Configuração do serviço, aba Opções do spec:
- Carregar operações sob demanda analisa cada operação na primeira requisição dela em vez de todas na inicialização. Acelera a subida dos specs grandes.
- Simplificar o schema corta os schemas exagerados (ramos anyOf/oneOf/allOf a mais) para os specs muito grandes continuarem administráveis.
Substituir um spec depois
A sua API muda; o mock acompanha trocando o arquivo. Em Configuração do serviço, escolha o serviço, abra o menu do canto e escolha Substituir arquivo. O caminho de montagem continua, e as escolhas de endpoint ficam iguais onde os caminhos batem, então o que você desligou continua desligado.
Faça o deploy de novo para entregar a versão nova.