Compartir vía

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

En este tutorial se explica cómo aumentar el inventario en el centro de API mediante la adición de 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 o una dirección, donde los usuarios pueden acceder a una API.

Para más información sobre las API, las implementaciones y otras entidades que puede inventariar en el Centro de API de Azure, 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

Prerrequisitos

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. Configure los metadatos integrados y los metadatos personalizados que haya definido en un tutorial anterior.

  1. Inicie sesión en Azure Portal y vaya al centro de API.

  2. En el menú de la barra lateral, en Activos, seleccione Entornos>+ Nuevo entorno.

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

    Configuración Importancia Description
    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 Opcionalmente, 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 Opcionalmente, 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 Opcionalmente, 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 e escriba las instrucciones de incorporación en Markdown estándar. Instrucciones para integrar con las API desde 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 el entorno

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

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

Adición de una implementación

El Centro de API también puede ayudarle a catalogar sus implementaciones de API y los entornos de tiempo de ejecución donde se han desplegado las API que usted está rastreando.

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

  1. En Azure Portal, vaya al Centro de API.

  2. En el menú de la barra lateral, en Activos, seleccione APIs.

  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 de línea de negocio personalizados u otros metadatos asignados a entornos, puede verlos en la parte inferior de la página.

    Configuración Importancia Description
    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 Opcionalmente, escriba una descripción. Descripción de la implementación
    Medio ambiente 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 API
    URL del runtime Escriba una dirección URL base, por ejemplo, https://api.contoso.com. Dirección URL de tiempo de ejecución 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. Selecciona 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

  • Last updated on