Você pode achar a solução apresentada em Como simular uma API em UM Minuto útil, assim como muitos outros desenvolvedores. Este artigo tem como objetivo introduzir uma abordagem para simular rapidamente uma API. No entanto, é importante notar que a solução anterior foi apenas uma pequena parte da ferramenta. Após uma exploração mais aprofundada, descobri recursos adicionais valiosos que podem ajudá-lo a simular dados complexos ainda mais rápido.
JSON Complexo
A primeira parte a ser abordada é como importar uma API Swagger no Apidog para simular alguns dados JSON. Assim, você pode ter seus dados simulados diretamente, sem qualquer script.
Mas alguns campos são complicados; você não pode simular eles sem configurações. Por exemplo, um campo enum tem vários valores opcionais. Geralmente aparece em campos de status. Ou um array com comprimento fixo. É frequentemente usado em uma tabela onde cada linha possui vários atributos e cada página tem 20 ou 50 linhas. Ou, um objeto que se refere a um schema. A especificação OpenAPI permite que uma API se refira a um schema como um objeto ou parte de um objeto.
Felizmente, agora podemos simular rapidamente todos esses JSON complexos em dois minutos no Apidog.
Como Simular APIs Complexas Rápido
Existem três etapas para simular a API.
- Importar definições da API.
- Definir campos específicos.
- Obter a URL simulada.
Tão fácil. Vamos simular!
Passo 1. Importar Definições da API.
Você só precisa de um OpenAPI JSON ou YAML e importá-lo no Apidog.
Passo 2. Definir Campos Específicos
Valores Enum
Nesta API de exemplo, o campo 'status' possui três valores opcionais: disponível, pendente e vendido. Portanto, espero que esse campo nos meus dados simulados tenha apenas um desses valores também.
Clique em 'Mais' no campo 'status'. Você verá um interruptor 'Enum'. Ative-o e você poderá adicionar valores enum. Depois disso, os dados desse campo serão simulados de acordo com as configurações.
Arrays com Comprimento Fixo
PhotoUrls é um campo de array. Eu preciso que ele tenha cinco itens fixos.
Clique em 'Mais' no campo 'PhotoUrls'. Você verá uma configuração de 'Limite de Elemento'. Defina minItems 5 e maxItems 5.
Objeto se Refere a um Schema
Apidog suporta schemas na especificação OpenAPI. Portanto, você só precisa selecionar um Schema para um objeto, e o Apidog simulará o objeto de acordo com o schema.
Por exemplo, o campo 'Categoria'.
Passo 3. Obter a URL Simulada
Clique em ‘Salvar', e mude para a aba 'API'. Copie a URL na parte "Mock Local" que começa com "127.0.0.1".
Cole a URL no navegador.
É isso.
Note esses campos: photoURLs com quantidade fixa de itens (5), enquanto URLs são simuladas automaticamente com URLs de imagem disponíveis; status com valores enum (vendido, pendente ou disponível), e categoria que se refere a um schema. Os outros campos, como cidade e createdAt, são simulados automaticamente.
E se você recarregar a URL, os dados simulados serão atualizados.
Schema JSON
Os tipos de dados OpenAPI 3.0 são baseados no Schema JSON, que descreve a estrutura de dados das APIs.
Apidog é compatível com OpenAPI. Intervalo de comprimento, formato e padrão (expressão regular) de strings, valor mínimo e máximo de inteiros, somente leitura/somente gravação; todos os atributos no Schema JSON são suportados.
Não apenas JSON, mas XML também é suportado para simulação. Você pode até definir os nomes das tags e prefixos dos dados XML.
Com base no Schema JSON, qualquer dado simulado complexo pode ser gerado facilmente com alguns cliques do mouse. Ainda assim, você não precisa escrever nenhum script.
Apenas aproveite.
Baixe o Apidog aqui, e aguarde meu próximo post para ver mais recursos poderosos de simulação.
