DEV Community

Cover image for Como simular APIs online sem configurar um servidor
jasonchan
jasonchan

Posted on

Como simular APIs online sem configurar um servidor

Existem muitas abordagens para simular dados JSON e usá-los offline. Mas se você precisar de alguns dados online no seu aplicativo, terá que executar um servidor de simulação no seu próprio servidor na nuvem.

Isso não é fácil, especialmente para desenvolvedores front-end.
Mas agora, há uma fantástica maneira de iniciar um servidor de simulação na nuvem, de forma fácil e gratuita.

Por que simular APIs online

No desenvolvimento local, dados simulados offline são suficientes para desenvolvedores front-end. Mas existem alguns cenários comuns em que os dados simulados offline não são suficientes.

Cenário 1: Dados simulados compartilhados pela equipe

Algumas estruturas de dados são complicadas, talvez com muitos campos ou seguindo esquemas complexos. Se vários desenvolvedores precisarem da mesma API simulada, a melhor solução é construir um servidor de simulação online que todos possam acessar.
Para equipes, dados simulados online compartilhados acelerariam muito o desenvolvimento. Os dados simulados podem ser definidos apenas uma vez.

Cenário 2: APIs em desenvolvimento

Em muitas equipes, as APIs não são bem projetadas no início. Uma especificação inicial de como as respostas da API devem parecer provavelmente mudará enquanto ela está sendo desenvolvida de verdade. Um dado simulado offline logo será diferente das respostas da API real.

Então, dados simulados online seguindo as especificações da API back-end seria ótimo.

Como simular

Em meus artigos anteriores, apresentei como simular dados dinâmicos em um servidor local rapidamente na ferramenta Apidog.
E agora descobri que simular em um servidor na nuvem também é fácil e gratuito!

Passo 1: Importar definições de API

A documentação da API é necessária. OpenAPI (Swagger) é o melhor, e qualquer outro formato também serve.

Crie um novo projeto no Apidog.

Criar projeto

Vá para "Setting" - "Import" e arraste o arquivo da sua API.

Importar API

Mais de dez formatos de documentação de API são suportados. Clique em "Avançar" e sua API será importada.

Passo 2: Ative o servidor de simulação na nuvem

Vá para "Settings" - "Feature Settings" - "Mock Settings" e ative o interruptor "Cloud Mock".
A simulação na nuvem pode ser acessada aberta ou você pode definir um token para ela.

Ativar simulação na nuvem

Passo 3: Obtenha a URL simulada

Clique em uma API no Apidog. Você verá uma página de definição da API, na qual há uma seção chamada "Mock". Copie a URL na parte "Cloud Mock" que começa com "mock.apidog.com".

URL simulada

Cole no seu navegador.

Pronto! Você verá um JSON simulado!

JSON simulado

Um campo "city" é preenchido com um nome de cidade, um campo "id" é preenchido com um número inteiro e "status" é um campo enum.

Agora você pode usar os dados da API no seu aplicativo, e qualquer pessoa da equipe pode acessar essa URL para obter dados.

Ainda assim, você não precisa escrever nenhum script. Os dados em todos os campos são gerados automaticamente.

E quando você clica em "reload" no navegador, os dados serão atualizados.

JSON simulado

APIs em desenvolvimento

Esta abordagem resolveu o cenário de dados simulados compartilhados pela equipe. Mas se a API ainda está em desenvolvimento, como os outros desenvolvedores podem obter os dados simulados mais recentes?

A solução também está no Apidog. O Apidog é um toolkit de desenvolvimento de APIs all-in-one, assim os desenvolvedores back-end podem usá-lo para depurar as APIs como no Postman e especificar APIs como no Stoplight. O Apidog pode sincronizar o Swagger automaticamente para que as especificações da API possam ser mantidas atualizadas. Quando as especificações da API mudam, os dados simulados online mudam sincronizando.

É um toolkit de desenvolvimento de APIs perfeito para trabalho em equipe.

Você pode registrar ou baixar o Apidog aqui.

Top comments (0)