Creación de un proxy API a partir de una especificación OpenAPI

Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Aprenderá a crear un proxy de API de Apigee a partir de una especificación OpenAPI mediante la interfaz de usuario de Apigee. Al llamar al proxy de API con un cliente HTTP, como cURL, este envía la solicitud al servicio de destino simulado de Apigee.

Acerca de la Iniciativa API Abierta

La Iniciativa Open API (OAI) se centra en la creación, el desarrollo y la promoción de un formato de descripción de API independiente del proveedor, basado en la Especificación Swagger. Para más información sobre la Iniciativa Open API, consulte la Especificación OpenAPI .

Una especificación OpenAPI utiliza un formato estándar para describir una API RESTful. Escrita en formato JSON o YAML, es legible por máquinas, pero también fácil de leer y comprender para humanos. La especificación describe elementos de una API como su ruta base, rutas y verbos, encabezados, parámetros de consulta, operaciones, tipos de contenido, descripciones de respuestas, etc. Además, una especificación OpenAPI se utiliza comúnmente para generar documentación de API.

Acerca del servicio de objetivos simulados de Apigee

El servicio de destino simulado de Apigee utilizado en este tutorial está alojado en Apigee y devuelve datos simples. No requiere clave API ni token de acceso. De hecho, puede acceder a él desde un navegador web. Pruébelo haciendo clic en el siguiente enlace:

http://mocktarget.apigee.net

El servicio de destino devuelve el saludo Hello, guest!

Para obtener información sobre el conjunto completo de API que admite el servicio de destino simulado, consulte las API de muestra de Apigee.

Lo que necesitarás

• Antes de comenzar, debe completar los pasos que se indican en Descripción general y requisitos previos .
• Una especificación OpenAPI. En este tutorial, usará la especificación OpenAPI mocktarget.yaml , que describe el servicio de destino simulado de Apigee ( http://mocktarget.apigee.net ). Para más información, consulte apigee/api-platform-samples .
• cURL instalado en su máquina para realizar llamadas API desde la línea de comandos; o un navegador web.

Crear el proxy API

Para crear el proxy API a partir de una especificación OpenAPI:

1. Si está utilizando la interfaz de usuario de Apigee en la consola de Cloud : seleccione Desarrollo de proxy > Proxies de API .

   Si está utilizando la interfaz de usuario clásica de Apigee : seleccione Desarrollar > Proxies de API y, en el panel Proxies , seleccione el entorno para el proxy.

2. Haga clic en Proxies API en la ventana principal.

   Alternativamente, puede seleccionar Desarrollar > Proxies API en la barra de navegación izquierda.

   

3. Haga clic en Crear nuevo .

   

4. En el asistente Crear proxy , haga clic en Usar especificación OpenAPI para la plantilla de proxy inverso (más común) .

   
5. Haga clic en la URL e ingrese la siguiente información:

   URL de especificación de OpenAPI : ruta al contenido sin procesar en GitHub para la especificación de OpenAPI en el campo URL :

   https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

6. Haga clic en Seleccionar .

   Se muestra la página de detalles del proxy en el asistente de creación de proxy . Los campos se rellenan previamente con los valores definidos en la especificación de OpenAPI, como se muestra en la siguiente figura:

   

   La siguiente tabla describe los valores predeterminados que se completan previamente mediante la especificación OpenAPI:

   Campo	Descripción	Por defecto
   Nombre	Nombre del proxy de la API. Por ejemplo: Mock-Target-API .	Propiedad title de la especificación OpenAPI con espacios reemplazados por guiones
   Ruta base	Componente de ruta que identifica de forma única este proxy de API dentro de la organización. La URL pública de este proxy de API se compone de su nombre de dominio externo o interno y esta ruta base. Por ejemplo: http://apitest.acme.com/mock-target-api	El contenido del campo de nombre se convirtió a minúsculas
   Descripción	Descripción del proxy API.	propiedad description de la especificación OpenAPI
   Objetivo (API existente)	URL de destino invocada en nombre de este proxy de API. Se puede usar cualquier URL accesible a través de internet. Por ejemplo: http://mocktarget.apigee.net	Propiedad servers de la especificación OpenAPI

   A continuación se proporciona un extracto de la especificación OpenAPI que muestra las propiedades que se utilizan para completar previamente los campos.

   openapi: 3.0.0
   info:
     description: OpenAPI Specification for the Apigee mock target service endpoint.
     version: 1.0.0
     title: Mock Target API
   paths:
     /:
       get:
         summary: View personalized greeting
         operationId: View a personalized greeting
         description: View a personalized greeting for the specified or guest user.
         parameters:
           - name: user
             in: query
             description: Your user name.
             required: false
             schema:
               type: string
         responses:
           "200":
             description: Success
   ...
   servers:
     - url: http://mocktarget.apigee.net
     - url: https://mocktarget.apigee.net
   ...
   

7. En la página de detalles del proxy , edite el campo Descripción de la siguiente manera:

   API proxy for the Apigee mock target service endpoint.

8. Haga clic en Siguiente .
9. En la página Políticas comunes , en Seguridad: Autorización , asegúrese de que esté seleccionado Pasar a través (sin autorización) y haga clic en Siguiente :

   

10. En la página Flujos , asegúrese de que todas las operaciones estén seleccionadas.
11. Haga clic en Siguiente .
12. En la página Resumen , asegúrese de que haya un entorno seleccionado en Implementación opcional y haga clic en Crear e implementar :

    

    Apigee crea su nuevo proxy API y lo implementa en su entorno:

13. Haga clic en Editar proxy para mostrar la página Descripción general del proxy API.

curl -v YOUR_ENV_GROUP_HOSTNAME/myproxy

curl -v -k https://apitest.acme.com/myproxy

Hello, Guest!

curl -v https://YOUR_ENV_GROUP_HOSTNAME/mock-target-api/xml

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

curl -v https://YOUR_ENV_GROUP_HOSTNAME/mock-target-api/xml

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}