APIs Innovación Technology
Terraform PoC blog

Los repositorios de definición son repositorios de código que ayudan a los ciclos de API First y que permiten automatizar las tareas de gobierno de APIs.

repos de definición

Stages

Los repositorios de definición pueden tener varias ramas, dependiendo de los entornos y del gitflow que se defina. Normalmente poseen al menos 3 ramas, mock, develop, pre y pro. A continuación se detallan las ramas:

  • Mock: permite subir la primera definición y generar el entorno mockeado.
  • Develop:  permite subir la versión de la api enlazada con los microservicios o sistemas que implementen la funcionalidad de la API
  • PRE: permite subir a los entornos no productivos 
  • PRO: permite desplegar en los entornos productivos
Gitflow

Principales tareas

Aunque cada organización puede definir los stages, se pueden definir los siguientes como base:

  • Validación de la definición. Se validará si el documento openapi cumple las buenas prácticas corporativas. Aquí se puede utilizar doSonarAPI o 42Crunch.
  • Generación de mocks. Permite generar mocks en base a los ejemplos. Aquí se puede utilizar prism, apisprout, getSandbox, Microcks…  
  • Generación de contract tests: En esta fase se deben generar las pruebas a completar por los desarrolladores y por el equipo de QA. La principal herramienta es openapi2postman o openapi2soapui.
  • Generación de código.  La autogeneración de código se puede hacer o bien con openapi.generator o bien con apigen.springboot o apigen.net
  • Pruebas automáticas: Se podrá realizar pruebas automáticas ya sea con la ejecución de newman 
  • Pruebas automáticas de seguridad: Se deberá comprobar las reglas OWASP. Se puede utilizar OWASP Zap Proxy o APISEC
APITools

Author

Marco Sanz

Leave a comment

Tu dirección de correo electrónico no será publicada.