Comportamento de simulações
Simulações fornecem respostas principalmente estáticas a solicitações que correspondem ao contrato da API. Elas respondem às solicitações sem se preocupar com qualquer segurança definida na API, no conteúdo da solicitação ou nos cabeçalhos da solicitação (exceto o cabeçalho Accept usado para negociação de conteúdo).
Quando uma solicitação é feita, a simulação cria uma resposta com base no que o usuário forneceu (exemplo, valor padrão, valor de enumeração) ou usando um valor de exemplo integrado.
Por exemplo, se a solicitação retornar um objeto, o exemplo do objeto será usado, caso tenha sido fornecido. Caso contrário, os exemplos de cada uma das propriedades serão usados e um objeto JSON será criado a partir deles. Isso também funciona para cabeçalhos de resposta.
Respostas
- Se a operação tiver apenas um intervalo de resposta, o primeiro status no intervalo será retornado. Por exemplo, uma operação com um intervalo de resposta 2XX retorna uma resposta 200.
- Se a operação tiver um código de resposta específico e intervalos de resposta ou uma resposta padrão, será retornado o código definido. Por exemplo, uma operação com uma resposta 201 e um intervalo de resposta 3XX retorna a resposta 201.
- Se a operação tiver vários intervalos de resposta e nenhum status de resposta definido, o primeiro status do primeiro intervalo será retornado. Por exemplo, uma operação com um intervalo de resposta 4XX e 5XX retorna uma resposta 400.
- Se a operação tiver apenas uma resposta padrão, a resposta retornada dependerá do método da operação:
- Se o método usado for POST, então será retornada uma resposta 201.
- Para outros métodos, será retornada uma resposta 204 se nenhum corpo de resposta for definido e uma resposta 200 será retornada se um corpo de resposta for definido.
- Se a operação não tiver uma resposta definida, será retornada uma resposta 200.
- Respostas 1XX não são permitidas em simulações. Se uma operação tiver o intervalo de resposta 1XX ou um código de resposta definido nesse intervalo, será retornada uma resposta 404.
Combinações
- Tudo de: se um exemplo for definido, ele será retornado. Se nenhum exemplo for definido para o tipo de dados, as propriedades dos tipos serão mescladas e os exemplos definidos no nível da propriedade serão usados ou valores de exemplo serão gerados. Se uma propriedade for definida duas vezes em tipos diferentes, somente o último valor será preservado. Os tipos primitivos são descartados, apenas objetos são retornados.
- Qualquer de ou Um de: se um exemplo for definido, ele será retornado. Se nenhum exemplo for definido, será gerada uma resposta a partir do primeiro tipo na lista.
Restrições
- Disponível apenas na solicitação: a propriedade é excluída do exemplo gerado.
- Disponível apenas na resposta: a propriedade é incluída no exemplo gerado.
- Disponível na solicitação e na resposta: a propriedade é incluída no exemplo gerado.
Os exemplos fornecidos no nível do tipo de dados têm precedência sobre as propriedades. Se uma propriedade definida como Disponível apenas na solicitação estiver incluída no exemplo, ela será retornada na resposta. Se uma propriedade definida como Disponível apenas na resposta ou Disponível na solicitação e na resposta não estiver incluída no exemplo, ela não será retornada na resposta.