Criar um Novo Projeto de API

No Apidog, cada projeto corresponde a uma Especificação de API ou a um ficheiro de Especificação OpenAPI (OAS). Pode criar um novo projeto de API ou importar um existente a partir da secção Início > As Minhas Equipas > Projetos da aplicação Apidog.

Criar 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. Suporta HTTP(s), WebSocket, Socket.IO, Webhook, Markdown e muito mais.

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

(Se selecionou Geral) Escolha o modo de projeto que prefere. 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. Também pode fazer cópias de segurança das Especificações OpenAPI geradas automaticamente para um repositório Git.

Selecione Modo Geral.

Introduza um nome para o seu projeto.

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

(Para equipas com vários utilizadores) Defina permissões para outros membros da equipa durante a criação do projeto. Para mais informações, consulte definições de permissões de membros.

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

Modo Spec-first (Beta)

Ideal para um fluxo de trabalho Git nativo. Crie especificações de API utilizando um Editor de Especificações OpenAPI (ficheiros YAML/JSON) e mantenha-as em sincronização bidirecional perfeita com o seu repositório Git.

Selecione Modo Spec-first.

Desloque-se para baixo até à secção Ligar ao Repositório Git.

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

(Para equipas com vários utilizadores) Defina permissões para outros membros da equipa. Para mais informações, consulte definiçõ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 commits Git, consulte o nosso guia detalhado sobre o Modo Spec-first.

Importar APIs Existentes

Se já tiver uma Especificação de API, pode iniciar o processo de importação a partir da secção Equipa > Projetos, selecionando Importar Projeto, ou diretamente dentro de um projeto existente, clicando no sinal ➕ grande e escolhendo Importar. Isto é ideal para migrar dados de API existentes para o Apidog.

Clique em "Importar Projeto".

Escolha o tipo de dados que pretende importar.

Carregue o ficheiro ou cole o URL dos dados (apenas formatos OpenAPI/Swagger).

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

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

Assim que a importação estiver concluída, o seu novo projeto estará pronto a utilizar.

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

Criar um Projeto#

Modo Geral#

Modo Spec-first (Beta)#

Importar APIs Existentes#

Criar um Projeto

Modo Geral

Modo Spec-first (Beta)

Importar APIs Existentes