Esta página se aplica a Apigee y Apigee Hybrid.
En este tema, se explica cómo crear y administrar versiones de API. Para obtener más información sobre las versiones, consulta Descripción general de las versiones.
Agrega una versión a una API
Puedes agregar una versión de API a una API existente en la consola o con la API de REST.
Console
Para agregar una versión nueva, haz lo siguiente:
En la consola de Google Cloud, dirígete a la página del concentrador de APIs.
Ir al concentrador de APIs- Haz clic en APIs.
- Busca la API de la que deseas actualizar la versión. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
- Haz clic en una API para ver sus detalles.
- En la pestaña Versiones, haz clic en Agregar versión.
- Especifica los detalles de la versión en el formulario Agregar una versión nueva. Debes proporcionar
un nombre visible. Los otros atributos son opcionales. Para obtener más información sobre los atributos, consulta Administra atributos.
- Nombre : Debes proporcionar un nombre visible (obligatorio).
- Descripción: Agrega una descripción de la versión.
- Ciclo de vida: Selecciona la etapa del ciclo de vida de la API.
- Cumplimiento: Selecciona un atributo de cumplimiento.
- Acreditación: Selecciona un atributo de acreditación.
- Documentación: Ingresa la URL de la documentación de la API.
- Agrega un archivo de especificación: importa un archivo de especificación de la API para asociarlo con la versión. Consulta Agrega una especificación de la API a una versión.
- Vínculo a una implementación: selecciona una o más implementaciones para asociarlas con la API.
- Atributos definidos por el usuario: Son atributos que defines según las necesidades de tu organización o equipo. Consulta Atributos de usuario.
- Haz clic en Crear.
REST
Para agregar una versión nueva con la API de Crea una versión de API, haz lo siguiente:
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions?version_id=VERSION_ID"
-H "Authorization: Bearer: $(gcloud auth print-access-token)" -X POST -H "Content-Type: application/json" \
'{
"display-name": DISPLAY_NAME,
"description": "DESCRIPTION" # description is an optional attribute
}'
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 al que se agregará la versión
- VERSION_ID: (Opcional) El identificador único de la versión de la API. Si no se proporciona, se usará un
ID generado por el sistema. El nombre debe ser una string de 4 a 63 caracteres, en la que los caracteres válidos son
/[a-z][0-9]-/. - DISPLAY_NAME: (Obligatorio) El nombre visible de la versión. Puedes usar cualquier nombre que desees.
- DESCRIPTION: Puedes agregar varios atributos opcionales para describir la versión, como una descripción, un nombre de propietario, un vínculo a la documentación y mucho más (opcional). Estos atributos opcionales se enumeran y describen en la definición del recurso de la versión.
Resultado de muestra:
{
"name": "projects/myproject/locations/myproject/apis/docs-api-1/versions/myversion1",
"displayName": "My Version 1",
"createTime": "2024-04-02T18:48:41.162360Z",
"updateTime": "2024-04-02T18:48:41.162360Z"
}
Genera una lista de versiones de API
En esta sección, se explica cómo enumerar las versiones asociadas con una API registrada.
Console
Para ver todas las versiones asociadas con una API registrada en la consola, sigue estos pasos:
En la consola de Google Cloud, dirígete a la página del concentrador de APIs.
Ir al centro de APIs- Haz clic en APIs.
- Ubica la API que deseas inspeccionar. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
- Selecciona una API
- Las versiones se enumeran en la tabla Versiones en la página de detalles de la API.
REST
Para ver todas las versiones asociadas con una API registrada mediante la API Muestra lista de versiones de API, haz lo siguiente:
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions" -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.
- API_ID: el ID único del recurso de la API.
Resultado de muestra:
{
"versions": [
{
"name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
"displayName": "Streetcarts Test v1"
}
]
}
Obtén detalles de la versión de la API
En esta sección, se explica cómo obtener los detalles sobre una versión de API, incluidos sus atributos, operaciones, implementaciones y archivos de especificación.
Console
Para ver los detalles de la versión en la consola, haz lo siguiente:
En la consola de Google Cloud, dirígete a la página del concentrador de APIs.
Ir al concentrador de APIs- Haz clic en APIs.
- Ubica la API que deseas inspeccionar. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
- Selecciona una API
- En la tabla Versiones, haz clic en una versión para ver la página de detalles de la versión.
REST
Para ver los detalles de una versión mediante la API de cómo obtener detalles de la versión de la API, haz lo siguiente:
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_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.
- VERSION_ID: El ID único de la versión.
Resultado de muestra:
{
"name": "projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1",
"displayName": "Test Version 3",
"documentation": {},
"specs": [
"projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/specs/docs-spec-1"
],
"apiOperations": [
"projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/listpets",
"projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/createpets",
"projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/deletepet",
"projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/getpetbyid",
"projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/operations/updatepet"
],
"definitions": [
"projects/myproject/locations/us-central1/apis/streetcarts/versions/streetcarts_testv1/definitions/pet"
],
"createTime": "2024-04-04T14:53:57.299213423Z",
"updateTime": "2024-04-04T14:53:58.027321138Z"
}
Borra una versión de API
En esta sección, se explica cómo borrar una versión de API asociada con un recurso de API. Puedes borrar una versión solo si se borran primero todas las especificaciones, operaciones, definiciones e implementaciones vinculadas subyacentes.
Console
Para borrar una versión, sigue estos pasos:
En la consola de Google Cloud, dirígete a la página del concentrador de APIs.
Ir al concentrador de APIs- Haz clic en APIs.
- Ubica la API que incluye la versión que deseas borrar. Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
- Selecciona una API
- En la tabla Versiones, busca la versión que deseas borrar.
- En el menú Acciones (el lado derecho de la fila que contiene la versión), haz clic en Borrar.
REST
Para borrar una versión con la API de Borrar versión de la API, haz lo siguiente:
curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \ 'https://apihub.googleapis.com/v1/projects/API_PROJECT/locations/API_LOCATION/apis/API_ID/versions/VERSION_ID'
Reemplaza lo siguiente:
- API_PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
- API_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.
- VERSION_ID: Es el ID de la versión que se borrará.
Edita una versión
Console
Para editar una versión, sigue estos pasos:
En la consola de Google Cloud, dirígete a la página del concentrador de APIs.
Ir al concentrador de APIs- Haz clic en APIs.
- Usa el Filtro para especificar palabras clave a fin de filtrar la lista de APIs. Si es necesario, usa Buscar para ubicar una API.
- Selecciona una API
- En la tabla Versiones, busca la versión que deseas editar.
- Selecciona Editar en el menú Acciones que se encuentra en el lado derecho de la fila de la versión. También puedes acceder a la función de edición si haces clic en Editar versión en la página de detalles de la versión. Para acceder a la página de detalles, haz clic en una versión en la tabla de versiones.
- Después de realizar las modificaciones, haz clic en Guardar para guardarlas. Para obtener una descripción de los atributos editables, consulta la descripción del recurso de la versión en la referencia de la API de REST.
REST
Para editar una versión con la API de REST, haz lo siguiente:
curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID/versions/VERSION_ID?updateMask=LIST_OF_ATTRIBUTES"
-H "Authorization: Bearer: $(gcloud auth print-access-token)" -X PATCH -H "Content-Type: application/json" \
'{
"display-name": DISPLAY_NAME, # Use the request body to specify attribute changes
"description": "DESCRIPTION"
}'
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 tiene la versión que deseas editar.
- VERSION_ID: El ID de la versión que se editará.
- DESCRIPTION: Puedes agregar otros atributos editables en el cuerpo de la solicitud, como la descripción y otros. Los atributos editables se enumeran en la referencia de la API de Apigee Hub. la API de la versión de parche
- LIST_OF_ATTRIBUTES: una lista separada por comas de nombres de atributos completamente calificados. Por ejemplo:
?updateMask="description".
Resultado de muestra:
{
"name": "projects/myproject/locations/us-central1/apis/streetcarts-test/versions/streetcarts-testv1",
"displayName": "Streetcarts Test v1",
"description": "This is a revision of the test version.",
"documentation": {},
"createTime": "2024-04-18T19:57:11.870761Z",
"updateTime": "2024-04-18T20:23:42.465324Z"
}