Registrar API

Estás viendo la documentación de Apigee X.
Consulta la documentación de Apigee Edge.

El registro de una API hace que los usuarios de la lista de API puedan detectarla.

Registrar API

Registra una API

Para registrar una API, sigue estos pasos:

  1. En Cloud Console, ve a la página Centro de API de Apigee.

    Ir al Centro de API

    La página de lista de las API se muestra de forma predeterminada.

  2. Haz clic en Register API. Se abrirá el panel Register API.
  3. Especifica los siguientes detalles de la API:
    • ID: Es un identificador para un recurso de API. El ID solo puede contener letras en minúscula, números y guiones. El ID debe ser único en el proyecto. Los ID deben tener entre 4 y 63 caracteres. Los ID no se pueden cambiar una vez que se registra una API. Por ejemplo, para el nombre del recurso de la API: projects/my-project/locations/global/apis/my-api, el ID del recurso es my-api.
    • Nombre: Ingresa el nombre de la API.
    • Descripción: Ingresa la descripción de la API
    • Estilo:
      • Estilo: Selecciona el estilo de arquitectura principal de la API (por ejemplo,OpenAPI, GraphQL, AsyncAPI, etc., según cómo se haya configurado el concentrador de API).
      • Documento de descripción de la API: Si tienes un documento de descripción existente, haz clic en Explorar para subirlo. Puede ser un único archivo o un archivo ZIP (2 MB como máximo). Para obtener información sobre cómo agregar y borrar revisiones, consulta Administra revisiones.
      • Tipo de MIME: Selecciona un tipo de MIME. El tipo de MIME se muestra después de que seleccionas un documento de descripción de la API. Si seleccionas Otro, se mostrará un campo de texto en el que podrás especificar el tipo de MIME de forma manual.
    • Versión actual:
      • ID de versión: Es un nombre para un recurso de API. El ID de versión solo puede contener letras en minúscula, números y guiones. El ID de versión debe ser único en el proyecto. Los ID de versión deben tener entre 1 y 63 caracteres. Los ID de versión no se pueden cambiar una vez que se registra una API.
      • Versión: ingresa la versión inicial.
      • Etapa del ciclo de vida de la API: Selecciona una etapa de ciclo de vida de la lista.
    • Final del ciclo de vida esperado
      • Selecciona una Expectativa de la lista.
      • Si la Expectativa es Fecha mínima, especifica una Fecha.
      • Si la Expectativa es Fecha de confirmación, especifica una Fecha.
    • Propiedades:
      • Taxonomías del sistema:
        • Usuarios objetivo: Selecciona los usuarios previstos (consumidores) de la API

        • Equipo: Selecciona el equipo responsable de producir la API.
        • Unidad de negocios: Selecciona la unidad de negocios responsable de la API
      • Taxonomías personalizadas:
        • Selecciona cualquier otra taxonomía personalizada que aparezca en la lista
    • Contacto principal:
      • Dirección de correo electrónico del contacto principal: La dirección de correo electrónico del contacto principal para realizar preguntas sobre la API
      • Descripción del contacto principal: La descripción del contacto principal
  4. Haz clic en Registrar API (o Cancelar).

Edita los detalles del registro de la API

Para editar los detalles del registro de la API, sigue estos pasos:

  1. En Cloud Console, ve a la página Centro de API de Apigee.

    Ir al Centro de API

    La página de lista de las API se muestra de forma predeterminada.

  2. Haz clic en una API. Se abrirá la página API Overview.
  3. Haz clic en  Editar.
  4. Modifica los detalles.
  5. Haz clic en Guardar (o Cancelar).

Borra una API

Borrar una API la quita del sistema. Si la API puede ser de interés histórico para otros, en lugar de borrarla, considera usar una etapa de ciclo de vida de Retirada o Abandonada.

Para borrar una API, sigue estos pasos:

  1. En Cloud Console, ve a la página Centro de API de Apigee.

    Ir al Centro de API

    La página de lista de las API se muestra de forma predeterminada.

  2. Haz clic en una API. Se abrirá la página API Overview.
  3. Haz clic en Borrar API.
  4. Aparecerá un diálogo de confirmación. Escribe el nombre de la API y, luego, haz clic en Confirmar (o Cancelar).

    Borra la confirmación de la API