Especificaciones de la API de carga

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

Preview — Apigee API hub

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Hay dos formas de agregar una especificación de API a una API registrada.

• Sube un archivo de especificación.
• Especifica el URI de un archivo de especificación.

Sube una especificación de API

Puedes subir y agregar una especificación de la API a una versión registrada de la API. Cuando subes una especificación de API, el concentrador de API la analiza y actualiza el recurso de API nuevo con metadatos extraídos de la especificación.

Nota: Aunque puedes subir especificaciones de tipo aaa, bbb, ccc y OpenAPI, el análisis solo se admite para especificaciones de OpenAPI.

En este documento, se explica cómo agregar una especificación de API a una versión de la API.

Sube un archivo de especificación de API

Console

1. En la consola de Google Cloud, dirígete a la página del concentrador de APIs.

   Ir al concentrador de APIs
2. Haz clic en APIs.
3. Selecciona la API registrada que deseas actualizar.
4. Haz clic en Agregar archivo de especificación.
5. Selecciona el archivo de especificación con uno de los siguientes métodos:
   • En el panel Archivo de especificación, navega al archivo de especificación que deseas subir.
   • En el campo URL del recurso, ingresa la URL de la especificación que deseas subir.
6. De manera opcional, agrega un nombre para la especificación.
7. Selecciona la versión de la API con la que asociarás el archivo de especificación.
8. Selecciona el tipo de archivo de especificación, como GraphQL, REST, YAML, etcétera.

REST

Para agregar un recurso de API con la API de REST, haz lo siguiente:

POST https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/apis/ID/versions/VERSION/specs?specIdSPEC_ID

    {
      "displayName": "DISPLAYNAME",
      "contents": "SPEC_CONTENTS",
      "mimeType": "MIME_TYPE" 
    {
  

Reemplaza lo siguiente:

• PROJECT: el nombre de tu proyecto host del concentrador de APIs. El proyecto host se seleccionó cuando se aprovisionó el concentrador de APIs.
• LOCATION: La ubicación del proyecto host. La ubicación se eligió cuando se aprovisionó el concentrador de APIs.
• ID: (opcional) si no proporcionas un ID, el sistema genera uno por ti. El ID es el último componente del nombre de recurso de la API de solo lectura, que tiene el siguiente formato: projects/PROJECT/locations/LOCATION/apis/ID
• VERSION: (obligatorio) la versión del recurso de API.
• SPEC_ID: (opcional) un ID para la especificación. Si no proporcionas este parámetro de búsqueda, se creará un ID generado por el sistema.
• DISPLAYNAME: (obligatorio) el nombre visible de la especificación de la API. Puedes usar cualquier nombre que desees.
• SPEC_CONTENTS: (obligatorio) el contenido de la especificación como una string codificada en base64. Tamaño máximo: 10 MB. Solo se admite la especificación de OpenAPI.
• MIME_TYPE: (obligatorio) el tipo de MIME del contenido. Por ejemplo, application/json, application/yaml, application/wsdl, etc.

Puedes agregar atributos opcionales adicionales para la API si los incluyes en el cuerpo de la solicitud o puedes agregarlos más adelante. Por ejemplo, puedes especificar una descripción, un propietario y un vínculo a la documentación de la API. Para obtener más información, consulta la API del concentrador de APIs.