Crear un nuevo proyecto de API

En Apidog, cada proyecto corresponde a una especificación de API o a un archivo de especificación OpenAPI (OAS). Puede crear un nuevo proyecto de API o importar uno existente desde la sección Inicio > Mis equipos > Proyectos de la aplicación Apidog.

Crear un proyecto

En la ventana principal, haga clic en el botón + Nuevo proyecto situado en la parte superior derecha.

Seleccione la categoría del proyecto en la parte superior: General o gRPC.

General: Elija esta opción para la mayoría de las API. Es compatible con HTTP(s), WebSocket, Socket.IO, Webhook, Markdown y más.

gRPC: Seleccione esta opción para API que utilizan el protocolo gRPC. Obtenga más información sobre los proyectos gRPC.

(Si seleccionó General) Elija el modo de proyecto que prefiera. Apidog ofrece dos flujos de trabajo distintos: Modo general y Modo Spec-first. Siga las instrucciones que aparecen a continuación según su selección.

Modo general

Ideal para flujos de trabajo basados en GUI. Incluye un editor visual de API para el diseño, la depuración, las pruebas y la documentación generada automáticamente de API. También puede realizar copias de seguridad de especificaciones OpenAPI generadas automáticamente en un repositorio Git.

Seleccione Modo general.

Introduzca un nombre para su proyecto.

(Opcional) Marque la opción Incluir ejemplos para crear un proyecto con datos de muestra del ejemplo PetStore.

(Para equipos con varios usuarios) Configure los permisos para otros miembros del equipo durante la creación del proyecto. Para obtener más información, consulte Configuración de permisos de miembros.

(Opcional) Configure el idioma del proyecto. Para obtener más información, consulte Configuración de idioma.

Modo Spec-first (Beta)

Ideal para un flujo de trabajo Git nativo. Diseñe especificaciones de API mediante un editor de especificaciones OpenAPI (archivos YAML/JSON) y manténgalas en una sincronización bidireccional fluida con su repositorio Git.

Seleccione Modo Spec-first.

Desplácese hacia abajo hasta la sección Conectar con repositorio Git.

Haga clic en Conectar a GitHub o en Conectar a GitLab SaaS para vincular su repositorio y configurar sus ajustes de sincronización.

(Para equipos con varios usuarios) Configure los permisos para otros miembros del equipo. Para obtener más información, consulte Configuración de permisos de miembros.

Más información

Para profundizar en el espacio de trabajo de especificaciones basado en código, el análisis de directorios en tiempo real y los flujos de trabajo de commits de Git, consulte nuestra guía detallada sobre el Modo Spec-first.

Importar API existentes

Si ya dispone de una especificación de API, puede iniciar el proceso de importación desde la sección Equipo > Proyectos seleccionando Importar proyecto, o directamente dentro de un proyecto existente haciendo clic en el signo ➕ grande y eligiendo Importar. Esto es ideal para migrar datos de API existentes a Apidog.

Haga clic en "Importar proyecto".

Elija el tipo de datos que desea importar.

Selección del tipo de datos para importar

Cargue el archivo o pegue la URL de los datos (solo formatos OpenAPI/Swagger).

Apidog reconocerá y analizará automáticamente el contenido según el formato seleccionado. Podrá previsualizar los datos antes de importarlos. Elija lo que desea importar y configure la lógica de importación. Luego confirme para crear e importar el proyecto.

Vista previa y configuración de la importación

Una vez completada la importación, su nuevo proyecto estará listo para usarse.

Más información

Para obtener información detallada sobre el proceso de importación, consulte las Directrices de importación.

Crear un nuevo proyecto de API

Crear un proyecto#

Modo general#

Modo Spec-first (Beta)#

Importar API existentes#

Crear un proyecto

Modo general

Modo Spec-first (Beta)

Importar API existentes