Las primeras 5 cosas que debe probar si es nuevo en Apigit

En Apigit, nos esforzamos por democratizar las API y empoderar a los usuarios para que utilicen y construyan API con la plataforma de API de Apigit para permitir un próspero mundo basado en API. Con más de decenas de miles de usuarios, continuamos expandiendo nuestro alcance y brindando acceso a las mejores oportunidades que Apigit tiene para ofrecer, desde principiantes hasta usuarios avanzados.

Para acceder a cualquiera de las funciones específicas que se enumeran a continuación, primero debe crear una cuenta de Apigit e iniciar sesión. Se puede acceder a Apigit directamente desde su navegador preferido.

Después de iniciar sesión, puede explorar estas cinco características interesantes para comenzar con Apigit.

1. Crea un repositorio

Después de crear su cuenta de Apigit, puede explorar las diversas funciones de la plataforma, incluida la creación de un repositorio. Un repositorio es un espacio donde puede almacenar su código y colaborar con otros.

Para crear un repositorio, navegue hasta la parte superior de su tablero de Apigit y haga clic en el+ firmar. En el menú desplegable, seleccioneNew repository. En la página siguiente, se le pedirá que ingrese un nombre y una descripción opcional para su repositorio. Después de proporcionar esta información, haga clic en el botón "Crear repositorio" para finalizar el proceso.

¡Felicitaciones, ha creado con éxito su primer repositorio en Apigit! Ahora puede comenzar a agregar archivos, colaborar con otros y utilizar muchas otras funciones de la plataforma.

Primer paso: crear un repositorio

2. Agregue una especificación API

Para agregar una especificación de API a su tablero de Apigit, haga clic en el+ letrero ubicado en la esquina superior izquierda. Introduzca un nombre de ruta, comotest/myfirst.json, junto con otra información relevante como latitle yversion.

Antes de agregar una nueva especificación de API, es posible que desee explorar el ejemplo proporcionado en su repositorio. Al hacer clic en el ícono 🪄 en la barra lateral izquierda, puede cambiar a un visor diferente. Por ejemplo, puede seleccionar elpetstore-json-format.json archivo de laexamples carpeta y cambiar el visor acode para ver el código de formato JSON para la especificación de ejemplo.

Para editar la especificación de su API, desplace el mouse sobre el archivo y haga clic en el⋮ al final del archivo o haga clic en el icono ✏️ ubicado en la parte inferior izquierda del tablero. Luego puede copiar el código JSON del ejemplo y usarlo para crear su propia especificación. Este es un ejemplo de cómo podría ser su primera especificación de API.

Segundo paso: Agregar una especificación de API

3. Crea y publica un servidor simulado

Los servidores simulados se utilizan a menudo en el desarrollo de API para simular el comportamiento de una API antes de que se implemente por completo. Los desarrolladores pueden usar servidores simulados para probar su código y asegurarse de que funciona como se espera, sin tener que esperar a que se complete la API o realizar solicitudes a un servidor real.

Implementar un servidor simulado en Apigit es un proceso simple. Primero, navegue a su repositorio y haga clic en elMock Server Script botón. Una vez que haya completado su script de servidor, publique el servidor. A continuación, puede encontrar la URL del servidor en elMock Servers página ubicada en el menú superior.

Tercer paso: crear y publicar un servidor simulado

4. Crear y publicar una prueba de API

La prueba de API es el proceso de verificar que las API se ajustan a sus especificaciones, pueden manejar diferentes tipos de entradas y salidas, y manejar correctamente errores y excepciones. Las pruebas de API se pueden realizar manualmente o con herramientas automatizadas que simulan solicitudes y respuestas a la API.

Para comenzar las pruebas de API en Apigit, haga clic en elTest Cases botón ubicado debajo de su repositorio. Aquí encontrará ejemplos de pruebas de API. Cree su propio caso de prueba y reemplace elbaseurl con la URL del servidor simulado generada en el paso 3.

Una vez que haya publicado su caso de prueba de API, puede buscarlo y ejecutarlo en elAPI Testing página. Puede acceder a esta página haciendo clic en elAPI Testing botón en el menú superior.

Cuarto paso: Crear y publicar una API Testing

5. Comparte tu trabajo

Apigit es una popular plataforma de colaboración de API que permite compartir el trabajo fácilmente. Ya sea que esté trabajando en un pequeño proyecto con un solo amigo o sea parte de una empresa con cientos de desarrolladores que trabajan activamente en una API pública, tiene control sobre lo que es visible y para quién.

Si ha creado algo que cree que el mundo debería ver, puede publicarlo en la red API de Apigit. Esto permitirá a los usuarios de Apigit de todo el mundo acceder a su colección.

Sigue explorando, al siguiente nivel

Ahora que domina algunos de los conceptos básicos, tómese un tiempo para explorar y descubrir funciones más útiles en Apigit. Por ejemplo, ¿sabía que puede diseñar un caso de prueba de API que dependa del resultado de otra API? Explore esta y muchas otras herramientas útiles disponibles en la plataforma.