Forem: jasonchan

Generate API Client Codes as per API Specs with Apidog

jasonchan — Wed, 31 Jan 2024 08:37:37 +0000

Writing API client code is not difficult for most experienced developers, but if there are many API endpoints, writing API client codes manually can be troublesome. Using tools like Apidog to auto-generate the API client codes can be a good choice.
Get start with Apidog

Especially for the teams that are using the API-first Approach, Using this tool to generate API client codes as per the existing API specs can save a lot of time and effort.

The Benefits of Using Generation Tools

When integrating our application with APIs (Application Programming Interfaces), we typically need to write API client code to interact with those APIs. Instead of manual Writing, here are some of the major benefits of using API client code generation tools.

Saves Effort and Time: Manually coding takes significant effort and time to handle aspects like API requests, error handling, serialization, tests etc. Codegen tools automate majority of this repetitive code.
Avoid Errors: Humans make mistakes. Doing repetitive tasks increases chance of bugs. Tools generate code programmatically thereby minimizing errors.
Consistency: Tools generate standardized, uniform code following best practices. Manual code tends to get messy with inconsistent conventions.
Handles Complexity: Tasks like serialization, API versioning, auth flows have complexity. Tools abstract this complexity into a clean usable interface.
Updates Handled Automatically: When API specs change, tools can auto-generate updated code seamlessly. Manual edits tend to miss details.
Language Choice: Tools can generate clients in multiple languages like TypeScript, Python, C# etc. Doing this manually takes massive effort.
Saves Learning Curve: Tools are easier to onboard and use rather than developers figuring out all the tooling and setup.

API Client Codes Generation Feature of Apidog

Apidog is regarded as a great API documentation and testing tool that allows you to design and test your APIs easily, so if you need to create a new API, you can easily design your API spec by filling a table with its GUI without any learning curve. Once you get your API spec design done, you can use its code generation features to auto-generate the API client code according to this API spec with ease.

Alternatively, you can import any of your existing API spec (YAML/ JSON) files into Apidog.

Apidog supports various data formats, whatever you are using to define your API specs, you can directly import them into Apidog easily.

1-Click to Generate API Client Codes with Apidog

Now, let me show you how Apidog can generate API client codes effectively for you. Once you've created or imported APIs into Apidog, you can find them in your project and easily generate the API client code for each.

Step1. Selecting API Endpoint

Open Apidog, and click the API endpoint you want to interact with, then you can see the detailed spec information in the right panel. To generate the API client codes for it, put the cursor on the "Generate Code" icon, then select "Generate Client Code" from the dropdown list.

Step2. Selecting the Language and Library

From the new popup window, you can choose your programming language, and then select the corresponding API request library, you can get a correct and accurate client code.

As we can see, Apidog supports mainstream programming languages and API request libraries. No matter what programming languages and API request libraries you are using, Apidog could be helpful for you.

Now, you can copy and paste this code anywhere to integrate with this API. I hope you can enjoy the code generation feature of Apidog.

It's really a good tool. Apart from API client codes, you can even generate Client SDK for your APIs in different languages.

Download Apidog here

Como simular APIs online sem configurar um servidor

jasonchan — Thu, 19 Oct 2023 03:39:13 +0000

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.

Vá para "Setting" - "Import" e arraste o arquivo da sua 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.

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".

Cole no seu navegador.

Pronto! Você verá um 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.

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.

Como Resolver os Limites de Coleções do Postman Gratuitamente

jasonchan — Fri, 13 Oct 2023 09:30:04 +0000

Se você é um usuário assíduo do Postman para testes de API, pode ter encontrado um problema frustrante onde você atinge o limite de execuções de coleções. Depois de atingir o limite, será exibida uma mensagem dizendo "Você esgotou todas as execuções. Para continuar executando coleções, crie uma conta..." Isso pode ser um verdadeiro obstáculo para seu fluxo de trabalho, especialmente se você estiver trabalhando em um projeto grande ou em equipe.

Felizmente, existem algumas soluções alternativas que você pode usar para contornar essa limitação e continuar executando suas coleções sem interrupções. Neste artigo, exploraremos alguns dos melhores métodos para superar o limite de coleção do Postman e continuar seus testes de API sem interrupções.

O que é uma Coleção do Postman

Uma Coleção do Postman é um grupo de solicitações que pode ser salvo e compartilhado com outros usuários. Ela permite que os desenvolvedores organizem, documentem e automatizem seus fluxos de trabalho de testes de API em um único local. Em uma Coleção do Postman, você pode incluir solicitações, testes e scripts, facilitando o compartilhamento de fluxos de trabalho de API com membros da equipe ou colaboradores.

A Coleção do Postman também permite a criação de variáveis personalizadas, que podem ser usadas para parametrizar solicitações e respostas, permitindo que os desenvolvedores criem testes de API dinâmicos. Ao usar uma Coleção do Postman, os desenvolvedores podem racionalizar seus processos de teste de API e melhorar sua eficiência geral.

Limitação da Coleção do Postman

O limite de Execução de Coleção do Postman se refere ao número de vezes que uma coleção pode ser executada dentro de um determinado período de tempo. Este limite é imposto para evitar o abuso da API do Postman e para garantir que o serviço permaneça estável para todos os usuários.

Para alinhar melhor com o valor que a automação de testes do Postman oferece para testadores profissionais e engenheiros de qualidade, o Postman fez as seguintes alterações efetivas em 15 de fevereiro de 2023, para clientes gratuitos, e 15 de março de 2023, para novos clientes de planos pagos. Clientes existentes de planos pagos viram esses limites vigentes na renovação do plano após 15 de março de 2023 (exceto usuários Enterprise, que têm execuções ilimitadas por mês):

Executor de Coleção Local: As execuções estarão disponíveis nos planos Gratuito e Básico com 25 execuções por mês, plano Profissional com 250 execuções por mês e plano Enterprise com execuções ilimitadas por mês.

É importante observar que o limite de Execução de Coleção se aplica a todas as coleções dentro de uma conta e não apenas a coleções individuais. Portanto, usuários com várias coleções que precisam de execução frequente podem precisar atualizar para um plano Postman superior para evitar atingir o limite de Execução de Coleção.

Como Corrigir as Restrições do Executor de Coleção do Postman?

Muitos usuários fiéis estão expressando frustração com as recentes mudanças de preços do Postman, especificamente em relação ao limite de execuções locais. Os clientes pagantes no plano básico agora têm o mesmo número de execuções da versão gratuita, e o limite de 25 no plano básico é visto como insensato por muitos. Alguns pedem que o Postman reconsidere as alterações, enquanto outros exploram ferramentas alternativas ao Postman como o Apidog, que oferecem mais flexibilidade sem restrições no número de execuções.

O Apidog é uma poderosa ferramenta de teste que supera o limite de Execução de Coleção no Postman. Ele oferece um robusto framework de teste e recursos de automação, feedback em tempo real e relatórios de teste abrangentes, bem como fácil integração com outras ferramentas de teste. O Apidog permite que os desenvolvedores criem, testem e gerenciem APIs de forma eficiente sem restrições, resultando em um processo de desenvolvimento mais produtivo.

Método 1. Criando sua coleção com o Apidog (Gratuito e melhor)

Diferentemente do Postman, o Apidog não impõe nenhum limite sobre quantas vezes uma coleção pode ser executada dentro de um determinado período de tempo. Isso significa que os desenvolvedores podem executar suas coleções tão frequentemente quanto precisarem, sem quaisquer restrições.

Uma coleção é um grupo de solicitações relacionadas que podem ser organizadas e executadas juntas. Existe um guia detalhado para criar uma solicitação de API.

Abra o Apidog e faça login. Se você ainda não baixou, basta clicar aqui.
Entre no seu projeto e clique em "Nova Solicitação" para criar uma nova solicitação ou mova o mouse para o diretório esquerdo e clique no botão + próximo à caixa de pesquisa à esquerda e selecione Nova Solicitação.
Insira a URL da API e os parâmetros para solicitar a API rapidamente.

Observação:

Se a URL inserida não começar com http:// ou https://, a URL de prefixo no ambiente atual será adicionada automaticamente quando a solicitação for enviada.

Depois de depurar, a solicitação pode ser salva como uma Nova Solicitação ou documento de API.
As Novas Solicitações salvas podem ser gerenciadas no diretório esquerdo.

Nova Solicitação suporta geração de código. Para mais detalhes, consulte Geração de Código.

Conclusão

Em conclusão, as limitações do Executor de Coleção do Postman podem ser um desafio significativo para desenvolvedores que precisam de acesso irrestrito para testar suas APIs. Felizmente, existem vários métodos para superar esse obstáculo. No entanto, uma das opções mais eficazes e amigáveis ao usuário é o Apidog.

Com o Apidog, os desenvolvedores podem criar, testar e gerenciar APIs de forma eficiente, sem quaisquer restrições, racionalizando seu processo de desenvolvimento. Portanto, recomendamos fortemente o uso do Apidog para garantir a melhor experiência de teste e superar as limitações do Executor de Coleção do Postman.

Simular corpos de REQUISIÇÃO automaticamente para acelerar a depuração de APIs

jasonchan — Fri, 13 Oct 2023 08:59:47 +0000

Ao desenvolver APIs, a depuração é sempre um problema chato.

O Postman pode ajudar a enviar solicitações, mas quando o corpo da API é complicado, a construção de um corpo JSON seria difícil. O Junit também funciona, mas todas as solicitações devem ser construídas por você mesmo nas classes de teste.

Corpos complexos fazem muitos backends abandonarem testes unitários e saírem com uma API não testada para desenvolvedores front-end e engenheiros de QA.

O caso acima demonstra que a qualidade do código declina sem uma boa ferramenta.

E agora, descobri que uma ferramenta chamada Apidog pode gerar o corpo da solicitação automaticamente ao depurar. A ferramenta pode construir um JSON de solicitação correto por si só.

Como simular

Esta abordagem funciona para equipes API-first. As APIs são projetadas antes do desenvolvimento, então durante a depuração, você tem uma especificação de API.

Importe as especificações da API para o Apidog. (Como?)
Abra uma API e verifique se a solicitação tem uma especificação de corpo JSON/XML.

Mude para a guia "Run" e clique no botão "Generate Automatically".

Pronto. Você obteve um JSON simulado de acordo com a especificação da solicitação!

E agora clique em "Send" para enviar a solicitação como fizemos no Postman, mas de forma mais eficiente. A maioria dos recursos no Postman também é suportada no Apidog.

Nossa equipe tem usado o Apidog para depurar APIs em vez do Postman por semanas.

O que mais há

Observe os dados simulados. Eles foram gerados automaticamente de acordo com o nome do campo. Um campo nomeado "cidade" é simulado com um nome de cidade, um campo chamado photoUrl é simulado com uma URL de foto e todos os dados simulados seguem o schema JSON especificado na API.

E isso não é o fim.

Passe o mouse sobre a seta ao lado de "Generate Automatically", você verá três itens de menu.

"Default value first" significa que o JSON simulado seria preenchido pelo valor padrão especificado em cada campo da API primeiro. "Example value first" significa que o JSON simulado seria carregado pelo JSON de solicitação de exemplo primeiro. Mas o que é "Atualizar ao enviar solicitação"?

É apenas o significado literal. Cada vez que a solicitação é enviada, o corpo é gerado novamente.

Interessante, não é?

Personalize

Até agora, tudo parece ótimo.

Mas e se alguns dos meus campos não forem esperados para mudar? Como posso tornar alguns campos fixos e outros simulados?

Clique no botão "Dynamic Value" e você encontrará um novo mundo.

Todas as sintaxes Faker.js são suportadas e você pode selecionar qualquer uma delas diretamente. Você pode até selecionar uma função para alterar o valor simulado, como md5, substr ou base64 etc.
Em seguida, será inserido no corpo da solicitação, assim.

Você pode decidir qual campo é fixo e qual é simulado pelo Faker.js. Ao enviar, todos os campos faker mudarão para os dados reais abaixo.

É isso. E muda cada vez que envia.

O Apidog é uma ótima ferramenta que faz nosso time construir APIs mais rapidamente. Eu gosto.

Baixe o Apidog aqui.

Apidog, cliente de API mais efetivo que o Postman

jasonchan — Fri, 13 Oct 2023 08:30:00 +0000

O Postman é uma boa ferramenta para depuração de API e é muito popular entre desenvolvedores web. No entanto, a depuração de API é apenas uma parte da gestão de API no desenvolvimento web. Temos que usar outras ferramentas, como o Swagger para projetar APIs, Jmeter para testar APIs, e assim por diante. Que problema se os dados da API forem inconsistentes entre as diferentes ferramentas.

Problemas no desenvolvimento web

"Como desenvolvedor web, eu só quero projetar as APIs e fazer quaisquer alterações/modificações que eu quiser. Atualmente, tenho que alternar entre diferentes ferramentas e fazer trabalhos repetitivos. Eu odeio isso."
— Desenvolvedor backend

"Ao escrever interfaces de usuário, preciso escrever scripts para simular dados com base nas definições de API. Eu nem posso saber se o projeto da API foi alterado ou não. Depois que a codificação estiver concluída, há mais da metade de chance de falhar na chamada das APIs reais."
— Desenvolvedor frontend

"Estou fazendo testes no Jmeter, mas tenho que copiar as informações da API para cá. Que desastre se os desenvolvedores modificaram a definição da API ou alteraram alguns parâmetros e não nos notificaram. Apenas por causa de uma pequena mudança, tenho que executar o processo de teste novamente e novamente"

— Engenheiro de testes

Em resumo, manter a consistência dos dados de diferentes ferramentas é muito difícil e ineficiente. A inconsistência de dados causa colaborações de equipe ineficientes e erros frequentes, o que é absolutamente um desastre para o desenvolvimento web.

Como poderíamos resolver problemas de inconsistência de dados e melhorar a eficiência da colaboração?
Existe um lugar onde todas as funções acima possam colaborar eficientemente no trabalho da API juntas?

Apidog, um espaço de trabalho All-in-One para APIs

Aqui está o site oficial do Apidog: apidog.com, que é um espaço de trabalho All-in-One para projetar, documentar, depurar, simular e testar APIs.
O Apidog integrou os recursos de gerenciamento de API acima e fez inovações centrais de visualizações e interações.
Esta ferramenta suporta um espaço de trabalho para diferentes funções no desenvolvimento web e mantém facilmente a consistência e sincronização de dados. Para equipes DEV, cada minuto conta!

Funcionalidades principais do Apidog

Projeto e documentação de API

Podemos projetar uma API muito rapidamente em minutos e a documentação é gerada automaticamente, que será sincronizada no projeto e para a equipe. O projeto API-First segue todas as regras OpenApi e JSON Schema, e a documentação de API gerada automaticamente pode ser facilmente compartilhada.
Os Esquemas de Dados também são suportados no Apidog para dados de resposta e parâmetros de solicitação. Uma vez definido, podemos reutilizar o schema de dados através de diferentes designs de API referenciando o modelo de schema.
Mais impressionante ainda, podemos fazer tudo isso visualmente.

Depuração de API

Para depuração de API, todas as funcionalidades do Postman são suportadas no Apidog, e mais inovações de visualização como pré/pós-processadores podemos descobrir.
O Apidog suporta variáveis de ambiente, scripts pré/pós, etc., totalmente compatível com o Postman. Além disso, as operações pré/pós (asserções, extrações de variáveis, operações de banco de dados, etc.) podem ser conduzidas visualmente. E os parâmetros de solicitação suportam variáveis dinâmicas também.
Vários casos de API podem ser salvos diretamente de acordo com a definição da API durante a depuração, e podemos usar casos diferentes separadamente a qualquer momento.

Simulação de dados de API

Outro projeto maravilhoso do Apidog é a simulação inteligente com um mecanismo de regras integrado do Faker.js. Podemos simular vários tipos de dados de acordo com as definições de API. Claro, simulações avançadas, como configurar uma expectativa, também são suportadas no Apidog.
Não mais scripts manuais para simulação de dados e nenhuma modificação repetitiva com base em alterações de API.

Teste de API

Para testes, podemos verificar todas as definições de API em um espaço de trabalho e referenciar diretamente a API/APICase em nossos casos de teste, que suporta scripts pré/pós personalizados (compatível com o Postman) também. Todos os casos de teste podem ser executados visualmente, enquanto os relatórios de teste são gerados diretamente, que podem ser facilmente exportados se necessário.
O Apidog segue testes orientados a dados, onde podemos gerenciar nossos conjuntos de dados (adicionar/modificar/importar/exportar) de forma muito conveniente. Além disso, podemos adicionar iterações e threads diretamente nos casos de teste para testes de desempenho.

Ainda mais inovações

Verificação automática do schema de dados

O Apidog verificará automaticamente o schema de dados de retorno durante a depuração de APIs. Não precisamos verificar manualmente ou usar scripts.

Definir asserções visualmente

Configuração de asserção:

Resultado da asserção após a execução:

Operações de banco de dados

Simulação inteligente

Vamos conferir as diferenças: o Apidog pode simular dados quase reais sem nenhum script manual.

Este é na verdade um projeto maravilhoso e um ponto inovador. O Apidog tem um mecanismo de regras Faker.js incorporado e pode gerar automaticamente regras de simulação de acordo com as definições de API (schema de dados, tipos de campo, etc.). Por exemplo, simular automaticamente uma URL de uma imagem se os dados do tipo String contiverem "imagem"; simular automaticamente uma string de carimbo de data/hora se os dados do tipo String contiverem "tempo"; simular automaticamente um nome de cidade real se os dados do tipo String contiverem "cidade".
Portanto, confiando nas regras internas, vários tipos de dados podem ser gerados automaticamente, como imagem, nome de usuário, número de telefone, URL, carimbo de data/hora etc. Além disso, para satisfazer necessidades individuais, o Apidog também suporta a personalização de regras de simulação, por meio do uso de RegEx ou wildcards.

Documentação de API online

A documentação da API pode ser facilmente compartilhada online para colaborações: URL de demonstração

Geração automática de código

O Apidog suporta a geração de código para quase todas as linguagens e frameworks de programação regulares (mais de 130), e os modelos de código também podem ser personalizados.

Funcionalidades de importação/exportação

O Apidog está trabalhando ativamente em funcionalidades para enriquecer o ecossistema de API. Podemos exportar diretamente vários tipos de dados (OpenApi, Markdown, Html, etc.) para trabalhos adicionais com API e importar diferentes tipos de dados (OpenApi, Postman, YApi, etc.) para o Apidog para facilitar as migrações de projeto.

Conclusão

O Apidog, um espaço de trabalho All-in-One para APIs, começa com colaboração, com foco em eficiência, insistindo em inovação e visando a próxima geração do Postman.
Comece grátis

Como criar um Mock de API em UM minuto

jasonchan — Fri, 13 Oct 2023 07:53:54 +0000

Desenvolvedores front-end geralmente encontram esse problema. A API é projetada, mas ainda não foi implementada. Eu preciso criar alguns dados falsos para a minha interface, o que significa que tenho que configurar um servidor de mock e adicionar alguns exemplos de resposta. Se não houver exemplos de resposta na documentação da API, eu mesmo terei que criar alguns dados de resposta.

Toda vez que faço isso, penso que não é o que um desenvolvedor front-end deveria fazer.

Deveria haver uma maneira melhor de conseguir isso.

Experimentei muitas ferramentas. Usei o Postman como servidor de mock, mas todos os dados de resposta precisam ser adicionados manualmente. Tentei o faker.js, mas tenho que escrever código de mock para cada campo.

Na minha expectativa, um excelente servidor de mock deveria gerar os próprios dados. Os desenvolvedores deveriam se concentrar nas coisas realmente essenciais.

Ótimas notícias: agora, você pode criar um mock de API em apenas um minuto. E você não precisa escrever nenhum script.

Por que fazer mock?

Fazer mock é uma boa escolha se você estiver em uma das seguintes situações:

A API está projetada, mas não desenvolvida. Isso geralmente acontece em equipes ágeis.
APIs restritas ou pagas. Por exemplo, APIs bancárias. Você não pode obter dados reais antes que o desenvolvimento seja concluído. Então, você precisa de dados falsos.
Ambiente offline ou intranet. Dados falsos permitem que você trabalhe em uma máquina local.

Vamos fazer o mock!

Existem duas etapas para mockar a API:

Importar as definições da API.
Obter a URL de mock.

Muito fácil! Vamos mockar!

Etapa 1 - Importar definições de API

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

Suponha que você tenha um arquivo YAML ou JSON. Vamos importá-lo nesta ferramenta: Apidog. Se você ainda não tem uma API, também pode criá-la no Apidog.

Crie um novo projeto no Apidog.

Vá em "Settings" - "Import" e arraste o arquivo da sua API.

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

Agora você verá as APIs no Apidog.

Etapa 2 - Obter a URL de mock

Clique em uma API no Apidog. Você verá uma página de definição da API, na qual há uma seção chamada "Mock".
Clique na URL na parte "Local Mock" que começa com "127.0.0.1" para copiá-la.

Cole-a no seu navegador.

Pronto, está feito! Você verá um JSON de mock!

Um campo "city" é preenchido com o nome de uma cidade, um campo "id" é preenchido com um número inteiro e "createdAt" é preenchido com uma data e hora.

Agora você pode usar os dados da API no seu App.

E você não precisa escrever nenhum script! Os dados em todos os campos são gerados automaticamente.

Além disso, se você clicar em "reload" no navegador, os dados serão atualizados!

Incrível.

Como isso funciona

Na primeira vez que encontrei esse recurso, fiquei bastante surpreso. Por que o Apidog consegue gerar isso? Eu não configurei nada!

Depois descobri o motivo.

Existe um conjunto de regras de mock internas no Apidog, como as acima. Se o nome do seu campo na definição de resposta corresponder a uma delas, os dados do campo serão mockados automaticamente.

E o Apidog inicia automaticamente um servidor de mock na sua máquina local. Então você não precisa fazer nada na camada de servidor.

E se você não gostar dos dados que ele mocka automaticamente? Isso também é fácil.

Você pode preencher diretamente o valor de mock do campo com Faker.js assim:

Toda gramática do Faker.js é suportada para que você possa selecioná-las facilmente.

E se algum campo tiver um valor fixo, você também pode preencher o "mock" com o valor especificado.

Pronto, tudo feito.

Espero que você faça mock feliz com o Apidog.

É realmente uma boa ferramenta. E descobri que não é só bom para mock, mas para tudo no desenvolvimento de APIs.
Faça o download do Apidog aqui

OpenAI GPT-3.5 Turbo and GPT-4 (Lower Pricing & New Model)🎉

jasonchan — Wed, 21 Jun 2023 09:08:39 +0000

On June 13, 2023, OpenAI announced a range of updates to its suite of language models, including enhanced steerability, improved function calling capabilities, extended context windows, and lower prices. In just six months, ChatGPT, a sibling model to InstructGPT which is trained to follow instructions and provide detailed responses, has quickly gained popularity worldwide since its launch on November 30, 2022. This update covers six major areas, and we're excited to dive into the details with you.

new function calling capability in the Chat Completions API
updated and more steerable versions of gpt-4 and gpt-3.5-turbo
new 16k context version of gpt-3.5-turbo (vs the standard 4k version)
75% cost reduction on our state-of-the-art embeddings model
25% cost reduction on input tokens for gpt-3.5-turbo
announcing the deprecation timeline for the gpt-3.5-turbo-0301 and gpt-4-0314 models

Function calling

The latest updates to GPT-4-0613 and GPT-3.5-turbo-0613 allow developers to describe functions to the models, which can then output a JSON object containing arguments to call those functions. This provides a new way for GPT models to connect with external tools and APIs to generate structured data output.
The models have been fine-tuned to detect when a function needs to be called and can respond with JSON that adheres to the function signature. This allows developers to create chatbots that answer questions by calling external tools, convert natural language into API calls or database queries, and extract structured data from text. The new API parameters support calling specific functions, and developers can refer to the developer documentation to add evals to improve function calling.

Function calling example

Step 1·OpenAI API
Call the model with functions and the user’s input
request:

curl https://api.openai.com/v1/chat/completions -u :$OPENAI_API_KEY -H 'Content-Type: application/json' -d '{
  "model": "gpt-3.5-turbo-0613",
  "messages": [
    {"role": "user", "content": "What is the weather like in Boston?"}
  ],
  "functions": [
    {
      "name": "get_current_weather",
      "description": "Get the current weather in a given location",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "The city and state, e.g. San Francisco, CA"
          },
          "unit": {
            "type": "string",
            "enum": ["celsius", "fahrenheit"]
          }
        },
        "required": ["location"]
      }
    }
  ]
}'

Response:

{
  "id": "chatcmpl-123",
  ...
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": null,
      "function_call": {
        "name": "get_current_weather",
        "arguments": "{ \"location\": \"Boston, MA\"}"
      }
    },
    "finish_reason": "function_call"
  }]
}

Step 2·Third party API
Use the model response to call your API, request like below:

curl https://weatherapi.com/...
{ "temperature": 22, "unit": "celsius", "description": "Sunny" }

Step 3·OpenAI API
Send the response back to the model to summarize
Request:

curl https://api.openai.com/v1/chat/completions -u :$OPENAI_API_KEY -H 'Content-Type: application/json' -d '{
  "model": "gpt-3.5-turbo-0613",
  "messages": [
    {"role": "user", "content": "What is the weather like in Boston?"},
    {"role": "assistant", "content": null, "function_call": {"name": "get_current_weather", "arguments": "{ \"location\": \"Boston, MA\"}"}},
    {"role": "function", "name": "get_current_weather", "content": "{\"temperature\": "22", \"unit\": \"celsius\", \"description\": \"Sunny\"}"}
  ],
  "functions": [
    {
      "name": "get_current_weather",
      "description": "Get the current weather in a given location",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "The city and state, e.g. San Francisco, CA"
          },
          "unit": {
            "type": "string",
            "enum": ["celsius", "fahrenheit"]
          }
        },
        "required": ["location"]
      }
    }
  ]
}'

Response:

{
  "id": "chatcmpl-123",
  ...
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "The weather in Boston is currently sunny with a temperature of 22 degrees Celsius.",
    },
    "finish_reason": "stop"
  }]
}

The weather in Boston is currently sunny with a temperature of 22 degrees Celsius.

Bigger Context Window

With the latest updates, GPT-4-32k-0613 and GPT-3.5-turbo-16k are now able to handle larger texts, which enhances their effectiveness for applications that require processing substantial amounts of text data. GPT-3.5-turbo-16k can now handle roughly 20 pages of text in a single request, which is four times larger than the previous model. In other words, users will soon be able to upload up to 20 pages of text into ChatGPT at once, providing a significant boost to its capabilities in dealing with larger text data.

New Models

OpenAI recently announced updates to their GPT-4 and GPT-3.5 Turbo models. GPT-4-0613 features an updated and improved model with function-calling capabilities. Meanwhile, GPT-4-32k-0613 has the same function-calling improvements as GPT-4-0613, along with an extended context length for better comprehension of larger texts.
The updates are set to enable more people to try GPT-4, and OpenAI is inviting many more from the waitlist over the coming weeks, with the intent to remove the waitlist entirely with this model. Similarly, GPT-3.5-Turbo-0613 has added function calling and more reliable steerability with the system message.
GPT-3.5-Turbo-16k features four times the context length of GPT-3.5-Turbo, at twice the price of 0.003 per 1K input tokens and0.003per1Kinputtokensand0.004 per 1K output tokens. This update means the model can now support ~20 pages of text in a single request.
OpenAI will upgrade and deprecate the initial models of GPT-4 and GPT-3.5 Turbo that were announced in March. Applications using the stable model names will automatically be upgraded to the new models on June 27th. Developers can also use the older models until September 13th by specifying the appropriate model names in their API requests. OpenAI welcomes feedback from developers to ensure a smooth transition.
In view of these updates, OpenAI's models are becoming more powerful and user-friendly, providing developers with exciting new capabilities to explore. From the improved function calling to the larger context length, these updates push the limits of natural language processing and put cutting-edge technology in the hands of developers worldwide.

Lower Pricing

OpenAI has recently announced a significant price reduction for its popular embeddings model, which has seen a 75% reduction in costs, down to $0.0001 per 1K tokens. This update is part of OpenAI's continuing efforts to make their systems more efficient and pass those savings on to developers.
The popular chat model GPT-3.5 Turbo that powers ChatGPT for millions of users has also received a price reduction, with a 25% decrease in input token costs. Developers can now use this model for just $0.0015 per 1K input tokens and $0.002 per 1K output tokens. The 16k context version, GPT-3.5-Turbo-16k, is priced at 0.003 per 1K input tokens and0.003per1Kinputtokensand0.004 per 1K output tokens, enabling developers to leverage this powerful model for larger text processing.
OpenAI values feedback from developers, and their suggestions are integral to the continued evolution of the platform. These latest updates are set to provide increased value and wider application opportunities for developers using OpenAI's models. With the lower pricing and other new features, OpenAI continues to be a leader in the natural language processing field.

GPT-4 model vs Chat Model (GPT-3.5-turbo)

GPT-3.5-turbo stands out with its lower cost, sufficient performance for general applications, and lower resource requirements, making it ideal for those with budget constraints or operating in resource-constrained environments. However, its limited context window and less powerful function calling might not be suitable for advanced applications.
On the other hand, GPT-4 offers enhanced function calling and a larger context window, which are beneficial for complex applications that require retaining extensive past information. However, it comes at a higher price point and requires greater computational resources. Choosing the right model for our needs can maximize benefits while staying within budget.

Model Deprecation

A process of upgrading and deprecating the initial versions of gpt-4 and gpt-3.5-turbo has begun, which were announced in March. The stable model names, including gpt-3.5-turbo, gpt-4, and gpt-4-32k, will automatically be upgraded to new models on June 27th. To compare model performance between versions, our Evals library supports public and private evaluations to demonstrate how model changes will impact your use cases.
If developers require more time to transition to the new models, they can still use the older models by specifying gpt-3.5-turbo-0301, gpt-4-0314, or gpt-4-32k-0314 in their API request. The older models will be available until September 13th, after which requests for those model names will be unsuccessful. To keep updated on model deprecations, you can visit our model deprecation page. As this is the first update to these models, we would appreciate developer feedback to ensure a smooth transition.

Conclusion

OpenAI has released new models and features that will enable developers to build powerful applications. The reduced pricing is particularly appealing, as it allows for more experimentation with web apps while minimizing expenses. It will be interesting to see how other developers capitalize on these updates.
Additionally, the ChatGPT plugin is an AI-powered tool that can help you efficiently handle customer service, marketing, and other business tasks. This article will introduce several creative use cases to bring more value to your business.

Fix Postman Collection Limits for Free🚀

jasonchan — Mon, 19 Jun 2023 04:26:23 +0000

If you're an avid user of Postman for API testing, you may have encountered a frustrating issue where you hit the limit for running collections. Once you've reached the limit, you'll be prompted with a message that says "You have exhausted all the runs. To keep running collections, create an account..." This can be a real hindrance to your workflow, especially if you're working on a large project or team.
Fortunately, there are some workarounds that you can use to bypass this limitation and keep running your collections smoothly.

What is a Postman Collection

A Postman Collection is a group of requests that can be saved and shared with other users. It allows developers to organize, document, and automate their API testing workflows in a single location. In a Postman Collection, you can include requests, tests, and scripts, making it easy to share API workflows with team members or collaborators.

The Postman Collection also allows for creating custom variables, which can be used to parameterize requests and responses, enabling developers to create dynamic API tests. By using a Postman Collection, developers can streamline their API testing processes and improve their overall efficiency.

Postman Collection Limitation

The Postman Collection Run limit refers to the number of times a collection can be executed within a given time period. This limit is imposed to prevent abuse of the Postman API and to ensure that the service remains stable for all users.
To better align with the value Postman’s test automation offers for professional testers and quality engineers, Postman made the following changes effective February 15, 2023, for free customers, and effective March 15, 2023, for new paid plan customers. Existing paid plan customers saw these limits effective upon plan renewal after March 15, 2023 (except Enterprise users, who have unlimited runs per month):

Local Collection Runner: Runs will be available with Free and Basic plans at 25 runs per month, Professional plan at 250 runs per month, and Enterprise plan at unlimited runs per month.
It's important to note that the Collection Run limit applies to all collections within an account and not just individual collections. Therefore, users with multiple collections that need frequent running may need to upgrade to a higher Postman plan to avoid hitting the Collection Run limit.

How to Fix Postman Collection Runner Restrictions?

Many loyal users are expressing frustration with Postman's recent changes to its pricing plan. Some are calling for Postman to reconsider the changes, while others are exploring Postman alternative tools like Apidog that offer more flexibility without any restrictions on the number of runs.
Apidog is a powerful testing tool that overcomes the Collection Run limit in Postman. It offers a robust testing framework and automation features, real-time feedback, and comprehensive test reports, as well as easy integration with other testing tools. Apidog enables developers to efficiently create, test, and manage APIs without restrictions, resulting in a more productive development process.

The Best Solution: Importing Postman into Apidog (Free & Best)

If you are also experiencing the Postman Collection Run limit, here is a sincere recommendation for the best solution. Importing collections from Postman to Apidog may seem like a challenge to you, especially for those who have been using Postman for a long time.
However, it is important to remember that there are more advantages to using Apidog than Postman. Apidog provides a more comprehensive testing platform, simplifies the checking process, and makes it easier for developers to identify and resolve issues. Next, you will get a handy guide to quickly importing Postman collections into Apidog.
**Step 1: Export Your Postman Collection
**First, you can use your Postman collections in a different program by exporting them. By selecting the desired collection and clicking the "Export" option, you can seamlessly transfer the collection from Postman to Apidog, as shown in the screenshot below.

In this step, it is recommended that you select the second option, Collection v2.1. This is because if you export the file in the Collection v2.1 format, all queries, directories, and details about your environment will be included in the file.

In addition, the exported file will include any request-specific information you may have, such as logs, query parameters, and content. Selecting the Collection v2.1 format, clicking Export, and saving the file to your computer are all necessary steps.

**Step 2: Import Collection in Apidog
**Log in to Apidog, and import the exported file as shown in the picture, select "Settings" from the left menu and then select "Import".

Select "Postman" and upload file from downloads. Upload output data source from Postman. Click “Confirm” button.

After a few simple steps above, you can now see and control the collections you have imported in Apidog. Adding, updating and deleting requests is easy. You can also group requests into folders.

**Step 3: Review Collection and Update
**Collaboration and content management within teams become more efficient when using Apidog. It allows for discussions, additions, and modifications to the collection, making it ideal for large projects with multiple participants. This streamlined process accelerates development and ensures data consistency among team members.
Additionally, Apidog's version control feature provides a reliable backup and facilitates easy switching between different collection versions. With Apidog, you can conveniently edit and update API information, as depicted in the image below.

**Step 4: Test Your Collection
**After importing the collection into Apidog, you can perform other operations, such as testing
Test your collection with different data inputs, authentication techniques, and API versions. Ensure proper error handling in the "Testing environment" section.

Access test results in Apidog's "Test Reports" section.

**Step 5: Deploy Your Collection
**After testing, use the "Run" button to publish your data to the API. Deploy your API to testing, development, or production environments. Utilize cloud platforms like Google Cloud Platform, Microsoft Azure, or Amazon Web Services (AWS) for scalability and reliability. Maintain an up-to-date API using a CI/CD pipeline.

With Apidog, you can collaborate, simulate API requests, and troubleshoot efficiently for faster development. These features improve communication, streamline workflows, and ensure reliable and scalable APIs.