Geração de respostas com simulações de API
Simulações de API respondem da forma mais realista possível a quaisquer chamadas que recebem. Ao gerar um corpo de resposta, a simulação dará prioridade aos dados fornecidos pelo usuário, procurando primeiro por um campo de exemplo, depois por um valor padrão e, por último, por um campo de enumeração. Se um campo de exemplo for encontrado, ele será usado como exemplo; caso contrário, um exemplo em JSON será gerado com base no tipo de dados retornado pela operação chamada.
Como exemplo, considere a definição do tipo de dados Empresa mostrada abaixo. Não contém nenhum exemplo fornecido pelo usuário.
Quando a simulação for ativada, uma chamada GET feita para o recurso /company/{companyId} retornará uma resposta JSON gerada automaticamente com base na estrutura do tipo de dados.
A simulação fez várias coisas interessantes, incluindo a geração de valores para cabeçalhos de resposta personalizados (por exemplo, x-my-custom-header), a identificação de arrays e a criação de exemplos apropriados (por exemplo, propriedade tags), e também a identificação de estruturas aninhadas e a geração de valores para elas (por exemplo, propriedade address).
As simulações do API Designer aceitam negociação de conteúdo, então você pode usar o cabeçalho de solicitação Accept para selecionar qual corpo deve ser retornado entre várias opções (cada uma potencialmente tem seu próprio exemplo), alterando, portanto, os exemplos retornados pela simulação.