Criar um Novo Projeto de API

No Apidog, cada projeto corresponde a uma Especificação de API ou a um arquivo de Especificação OpenAPI (OAS). Você pode criar um novo projeto de API ou importar um existente na seção Início > Minhas Equipes > Projetos do aplicativo Apidog.

Criando um Projeto

Na janela principal, clique no botão + Novo Projeto no canto superior direito.

Selecione a categoria do projeto na parte superior: Geral ou gRPC.

Geral: Escolha esta opção para a maioria das APIs. Ela oferece suporte a HTTP(s), WebSocket, Socket.IO, Webhook, Markdown e muito mais.

gRPC: Selecione esta opção para APIs que usam o protocolo gRPC. Saiba mais sobre projetos gRPC.

(Se você selecionou Geral) Escolha o modo de projeto de sua preferência. O Apidog oferece dois fluxos de trabalho distintos: Modo Geral e Modo Spec-first. Siga as instruções abaixo com base na sua seleção.

Modo Geral

Ideal para fluxos de trabalho baseados em GUI. Inclui um Editor Visual de API para design, depuração, testes e documentação gerada automaticamente. Você também pode fazer backup das Especificações OpenAPI geradas automaticamente em um repositório Git.

Selecione Modo Geral.

Insira um nome para o seu projeto.

(Opcional) Marque a opção Incluir Exemplos para criar um projeto com dados de amostra do exemplo PetStore.

(Para equipes com vários usuários) Defina permissões para outros membros da equipe durante a criação do projeto. Para obter mais informações, consulte Configurações de permissões de membros.

(Opcional) Defina o idioma do projeto. Para obter mais informações, consulte Configurações de idioma.

Modo Spec-first (Beta)

Ideal para um fluxo de trabalho Git nativo. Projete especificações de API usando um Editor de Especificação OpenAPI (arquivos YAML/JSON) e mantenha-as em sincronização bidirecional contínua com seu repositório Git.

Selecione Modo Spec-first.

Role para baixo até a seção Conectar ao Repositório Git.

Clique em Conectar ao GitHub ou Conectar ao GitLab SaaS para vincular seu repositório e configurar suas definições de sincronização.

(Para equipes com vários usuários) Defina permissões para outros membros da equipe. Para obter mais informações, consulte Configurações de permissões de membros.

Saiba Mais

Para uma análise aprofundada do espaço de trabalho de Especificações orientado por código, da análise de diretórios em tempo real e dos fluxos de trabalho de commit do Git, confira nosso guia detalhado sobre o Modo Spec-first.

Importar APIs Existentes

Se você já tiver uma Especificação de API, poderá iniciar o processo de importação pela seção Equipe > Projetos selecionando Importar Projeto, ou diretamente dentro de um projeto existente clicando no sinal grande ➕ e escolhendo Importar. Isso é ideal para migrar dados de API existentes para o Apidog.

Clique em "Importar Projeto".

Escolha o tipo de dados que deseja importar.

Carregue o arquivo ou cole a URL dos dados (somente formatos OpenAPI/Swagger).

O Apidog reconhecerá e analisará automaticamente o conteúdo com base no formato selecionado. Você poderá visualizar os dados antes de importar. Escolha o que deseja importar e configure a lógica de importação. Em seguida, confirme para criar e importar o projeto.

Pré-visualização e configuração de importação

Quando a importação for concluída, seu novo projeto estará pronto para uso.

Saiba Mais

Para obter informações detalhadas sobre o processo de importação, consulte as Diretrizes de Importação.

Criar um Novo Projeto de API

Criando um Projeto#

Modo Geral#

Modo Spec-first (Beta)#

Importar APIs Existentes#

Criando um Projeto

Modo Geral

Modo Spec-first (Beta)

Importar APIs Existentes