Administra recursos de API

Esta página se aplica a Apigee y Apigee Hybrid.

Registra una API

Cuando registras una API con el concentrador de APIs, creas y almacenas una entidad que representa a la API. Esta entidad se denomina recurso de API. Los recursos de API almacenados en el concentrador de APIs se pueden buscar y proporcionan información operativa y descriptiva detallada sobre la API. Ya sea cuando registras una API o después, puedes agregar y editar atributos de recursos de API para compilar una descripción enriquecida de la API.

Console

Para registrar una API, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página APIs en el Concentrador de APIs.

    Ir al concentrador de APIs
  2. Haz clic en Register API.

  3. En Detalles generales, puedes especificar un ID único para la API. Si no proporcionas un ID, el sistema generará uno por ti. Si deseas ingresar un ID, haz clic en Especificar ID único.

    El ID debe tener entre 4 y 500 caracteres, y los caracteres válidos son /[A-Z][a-z][0-9]-/.. El ID es el último componente del nombre de recurso de API único y completamente calificado, que tiene el siguiente formato: projects/PROJECT/locations/LOCATION/apis/API_ID

  4. Proporciona un nombre visible para el recurso de API (obligatorio).
  5. También puedes agregar atributos adicionales que describan la API. Puedes volver a la API en cualquier momento para agregar o cambiar los atributos de la API. Consulta Edita un recurso de API.
    • Información del propietario: El nombre y la dirección de correo electrónico del propietario de la API (opcional).
    • Detalles adicionales: Especifica atributos para ayudar a definir tu API y facilitar la búsqueda (opcional). Puedes definir valores predeterminados para algunos de estos atributos en Configuración. Para obtener más información, consulta Administra atributos.
    • Atributos definidos por el usuario: (Opcional) Estos son atributos que defines en Configuración. Para obtener más información, consulta Administra atributos.
  6. Haz clic en Registrar.

REST

Para registrar una API, usa la API de REST Crear API.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{
    "display_name": "DISPLAY_NAME",            # Required attribute
    "description": "DESCRIPTION"               # description is an optional attribute
    }
    'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis?api_id=API_ID

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • API_ID: Ingresa un ID único para la API (opcional). Si no proporcionas este parámetro de búsqueda, el sistema generará un ID único para ti. El ID debe tener entre 4 y 500 caracteres, y los caracteres válidos son /[A-Z][a-z][0-9]-/.. El ID es el último componente del nombre de recurso de API único y completamente calificado, que tiene el siguiente formato: projects/PROJECT/locations/LOCATION/apis/API_ID
  • DISPLAY_NAME: (obligatorio) el nombre visible del recurso de API. Puedes usar cualquier nombre que desees.
  • DESCRIPTION: Puedes agregar varios atributos opcionales para describir el recurso de API, incluidos una descripción, un propietario, un vínculo a la documentación de la API y mucho más (opcional). Estos atributos opcionales se enumeran y describen en la definición de recursos de API.

Enumera recursos de API

En esta sección, se explica cómo enumerar los recursos de API en el concentrador de APIs. Si agregas un filtro, puedes limitar las APIs que se muestran en la respuesta.

Console

Para enumerar los recursos de API, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página APIs en el Concentrador de APIs.

    Ir al centro de APIs

    En la página principal de las APIs, se muestra una lista de todas las APIs agregadas al concentrador de APIs.

  2. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.

REST

Para enumerar todos los recursos de API en tu proyecto del concentrador de APIs, usa la API de Enumerar APIs:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis"
  -X GET -H "Authorization: Bearer: $(gcloud auth print-access-token)" -H "Content-Type: application/json"

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.

Resultado de muestra:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-2",
      "displayName": "TestApi2",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-1",
      "displayName": "TestApi1",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo9013cfev",
      "displayName": "sample",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo90121",
      "displayName": "sample",
      "documentation": {}
    },
    ...
    ],
    "nextPageToken": "f4f4d78b-a974-46db-a214-dc139f8e9c8a"
  }

Ejemplo de REST con filtro

Puedes filtrar los resultados de las listas con la API. En este ejemplo, filtramos las APIs según un atributo definido por el sistema: 

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis' \
  -d filter="owner.email=\"testowner3@gmail.com\"" -d page_size=10

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.

Resultado de muestra, filtrado por propietario:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/theme-park-management-api",
      "displayName": "Theme Park Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/restaurant-api",
      "displayName": "Restaurant API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/casino-management-api",
      "displayName": "Casino Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/hotel-boooking-api",
      "displayName": "Hotel Booking API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api3",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api2",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api1",
      "displayName": "Test Pets API",
      "documentation": {}
    }
  ]
}

Obtén detalles de recursos de API

En esta sección, se explica cómo obtener los detalles sobre un recurso de la API.

Console

Para ver los detalles de un recurso de API, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página APIs en el Concentrador de APIs.

    Ir al centro de APIs
  2. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
  3. Haz clic en una API para ver sus páginas detalles.

REST

Para ver los detalles de un recurso de API, usa la API Obtener detalles del recurso de API:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • API_ID: el ID único del recurso de la API.

Resultado de muestra:

{
  "name": "projects/myproject/locations/us-central1/apis/myapi",
  "displayName": "My Test API",
  "description": "This is a test API.",
  "documentation": {},
  "owner": {
    "displayName": "Test API,
    "email": "testowner@gmail.com"
  },
  "versions": [
    "projects/myproject/locations/us-central1/apis/myapi/versions/myapi-version1"
  ],
  "createTime": "2024-03-26T10:13:15.668867002Z",
  "updateTime": "2024-03-26T10:13:16.700716401Z"
}

Borra un recurso de API

En esta sección, se explica cómo borrar un recurso de API.

Console

Cuando borras una API en la IU, se borran todas las versiones subyacentes de la API y las especificaciones asociadas (si las hay).

Para borrar un recurso de API, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página APIs en el Concentrador de APIs.

    Ir al centro de APIs
  2. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API que quieras borrar.
  3. En el menú Acciones (el lado derecho de la fila que contiene la API), haz clic en Borrar.

REST

Para borrar una API del concentrador de APIs, usa la API Borrar API.

De forma predeterminada, una API solo se puede borrar si se borran todas las versiones subyacentes. Si deseas borrar todas las versiones de una API en un solo paso, establece el parámetro de consulta force en true en la API de Delete REST.

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID'

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • API_ID: El ID único del recurso de API que se borrará.

Para borrar la API y todas las versiones subyacentes, establece el parámetro de consulta force en true. Por ejemplo:

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID?force=true'

Edita un recurso de API

En esta sección, se explica cómo editar un recurso de API. No todos los atributos de los recursos de la API se pueden editar. Para obtener la lista de atributos editables, consulta el documento de referencia de la API de parche.

Console

Para editar una API, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página APIs en el Concentrador de APIs.

    Ir al centro de APIs
  2. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API que se pueda editar.
  3. Haz clic en una API para ver sus páginas detalles.
  4. Haz clic en Editar API.
  5. En la página Editar API, realiza los cambios. Haz clic en Continuar para pasar al siguiente conjunto de atributos editables.
    • Detalles generales: Puedes editar el nombre visible de la API.
    • Información del propietario: El nombre y la dirección de correo electrónico del propietario de la API.
    • Detalles adicionales: Estos son los atributos definidos por el sistema. Puedes especificar valores predeterminados personalizados para estos atributos en Administrar atributos.
    • Atributos definidos por el usuario: Son los atributos personalizados definidos por el usuario. Puedes especificar atributos personalizados en Administrar atributos.
  6. Haz clic en Guardar.

REST

Para editar un recurso de API, usa la API de recursos de la API de parche.

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{
          "display_name": "Updated Test Docs API",        # Example request body with changes
          "description": "This is the updated test API.",
          "owner": {
            "display_name": "Updated Docs Owner",
            "email": "updateddocsowner@gmail.com"
            }
          }
          ' https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID

Reemplaza lo siguiente:

  • HUB_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
  • HUB_LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
  • API_ID: el ID único de la API que se actualizará.
  • Cuerpo de la solicitud: Usa el cuerpo de la solicitud para especificar los atributos que deseas cambiar. Consulta la descripción del cuerpo de la solicitud a la API.