El propósito de este documento es guiar en la creación de la estructura de archivos necesaria para el despliegue de un API utilizando el pipeline de APIM.

Este documento está dirigido a los LT, arquitectos, developers, operaciones y demás personal técnico que necesite configurar su repositorio para hacer uso del pipeline de APIM

CONTROL DE VERSIONES DEL DOCUMENTO

​

​

1. Propósito

El propósito de este documento es guiar en la creación de la estructura de archivos necesaria para el despliegue de un API utilizando el pipeline de APIM.

Este documento está dirigido a los LT, arquitectos, developers, operaciones y demás personal técnico que necesite configurar su repositorio para hacer uso del pipeline de APIM

2. Requisitos

• Repositorio en bitbucket con acceso para editar fuentes
• OpenAPI Specification(Archivo de Especificación OpenAPI)
• Politicas de operaciones de API Management - Opcional
• Properties (Named Values) - Opcional

3. Estructura de archivos y directorios

En el repositorio de archivos se deberia de definir la siguiente estructura de archivos.

Nota: Los nombres de los directorios y archivos y prefijos de archivos ya se han establecido por convensión y no se deberian de alterar

Prefijo de archivos

• OAS: este prefijo se utiliza para los archivos de OpenAPI Specification seguido del nombre del API.

• Policy: se utiliza para los archivos que contienen la definición de las politicas de API

  • Todas las operaciones allOperations.xml: se definen las politicas que afectan a todas las operaciones del API.

  • Operaciones especificas specificOperation.xml: se definen las politicas que afectan a una sola operación, el nombre que va seguido del prefijo hace referencia al valor de la propiedad operationId de los metodos en los paths del archivo OAS.

• Property: se utiliza para archvos que definen secretos(Named Values) del servicio de Azure Api Management(APIM)

  Nombres de directorios

• v1/: directorio donde se ubican los archivos de la versión major del API por ejemplo v1 hace referencia a 1.x.x

• contract/: directorio donde se ubica el archivo de especificación OpenAPI.

• policies/: directorio donde se ubican los archivos de la definición de politicas de API.

• properties/: directorio donde se ubican los archivos de definición de secretos(Named Values)

Nombres de archivos

• main.yml: archivo que define la versión actual y la versión de rollback que se publicará en el servicio de APIM de azure.