Compartir a través de

Tutorial: Adición de entornos e implementaciones para las API

  • Artículo

Aumente el inventario en el centro de API agregando información sobre los entornos de API y las implementaciones.

  • Un entorno representa una ubicación en la que se podría implementar un entorno de ejecución de API, por ejemplo, una plataforma de API Management.

  • Una implementación es una ubicación (una dirección) donde los usuarios pueden acceder a una API.

Para obtener información general sobre las API, las implementaciones y otras entidades que puede inventariar en Azure API Center, consulte Conceptos clave.

En este tutorial, aprenderá a usar el portal para:

  • Adición de información sobre entornos de API
  • Adición de información sobre las implementaciones de API

Requisitos previos

Adición de un entorno

API Center le ayuda a realizar un seguimiento de los entornos de API reales. Por ejemplo, puede usar Azure API Management u otra solución para distribuir, proteger y supervisar algunas de sus API. O bien, puede atender directamente algunas API mediante un servicio de proceso o un clúster de Kubernetes.

Aquí agregará un entorno ficticio de Azure API Management a la instancia de API Center. Si lo prefiere, agregue información sobre uno de los entornos existentes. Configurará los metadatos integrados y los metadatos personalizados definidos en un tutorial anterior.

  1. En el portal, vaya al centro de API.

  2. En el menú izquierdo, en Recursos, seleccione Entornos>+ Nuevo entorno.

  3. En la página Nuevo entorno, agregue la siguiente información. Si ha definido previamente los metadatos Línea de negocio personalizados u otros metadatos asignados a entornos, los verá en la parte inferior de la página.

    Configuración valor Descripción
    Título del entorno Escriba Mis pruebas. Nombre que elija para el entorno.
    Identificación Después de escribir el título anterior, Azure API Center genera este identificador, que puede invalidar. Nombre del recurso de Azure para el entorno.
    Tipo de entorno Seleccione Pruebas en la lista desplegable. Tipo de entorno para las API.
    Descripción Si lo desea, escriba una descripción. Descripción del entorno.
    Servidor
    Tipo Opcionalmente, seleccione Azure API Management en la lista desplegable. Tipo de solución de API Management usada.
    URL del portal de administración De manera opcional, escriba una dirección URL para una interfaz de administración, como https://admin.contoso.com Dirección URL de la interfaz de administración para el entorno.
    Incorporación
    Dirección URL del portal de desarrollo De manera opcional, escriba una dirección URL para un portal para desarrolladores, como https://developer.contoso.com Dirección URL de la interfaz para la incorporación de desarrolladores en el entorno.
    Instrucciones Opcionalmente, seleccione Editar y escriba las instrucciones de incorporación en Markdown estándar. Instrucciones para incorporar a las API del entorno.
    Línea de negocio Si agregó estos metadatos personalizados, de manera opcional realice una selección en la lista desplegable, como TI. Metadatos personalizados que identifican la unidad de negocio que administra el entorno.

    Captura de pantalla de cómo agregar un entorno de API en el portal

  4. Seleccione Crear. El entorno aparece en la lista de entornos.

Adición de una implementación

API Center también puede ayudarle a catalogar las implementaciones de API: los entornos de ejecución en los que se implementan versiones de API específicas.

Aquí agregará una implementación al asociar una de las API con el entorno que creó en la sección anterior. Configurará los metadatos integrados y los metadatos personalizados que haya definido.

  1. En el portal, vaya al centro de API.

  2. En el menú de la izquierda, en Recursos, seleccione API.

  3. Seleccione una API, por ejemplo, Conference API.

  4. En la página Conference API, en Detalles, seleccione Implementaciones>+ Agregar implementación.

  5. En la página Agregar implementación, agregue la siguiente información. Si ha definido previamente los metadatos Línea de negocio personalizados u otros metadatos asignados a entornos, los verá en la parte inferior de la página.

    Configuración valor Descripción
    Título Escriba Implementación de v1. Nombre que elija para la implementación.
    Identificación Después de escribir el título anterior, Azure API Center genera este identificador, que puede invalidar. Nombre del recurso de Azure para la implementación.
    Descripción Si lo desea, escriba una descripción. Descripción de la implementación.
    Entorno Realice una selección en la lista desplegable, como Mis pruebas o, de forma opcional, seleccione Crear nuevo. Entorno nuevo o existente en el que se implementa la versión de la API.
    Definición Seleccione o agregue un archivo de definición para una versión de Conference API. Archivo de definición de la API.
    URL del runtime Escriba una dirección URL base, por ejemplo, https://api.contoso.com. Dirección URL del runtime base para la API en el entorno.
    Línea de negocio Si agregó estos metadatos personalizados, de manera opcional realice una selección en la lista desplegable, como TI. Metadatos personalizados que identifican la unidad de negocio que administra las API en el entorno.

    Captura de pantalla de cómo agregar una implementación de API en el portal

  6. Seleccione Crear. La implementación aparece en la lista de implementaciones.

En este tutorial, aprenderá cómo usar el portal para:

  • Adición de información sobre entornos de API
  • Adición de información sobre las implementaciones de API

Contenido relacionado