Gestionar recursos

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

Consulta la documentación de Apigee Edge.

Nota: En los entornos en los que está habilitada la función de archivar implementaciones, no puedes gestionar recursos con la interfaz de usuario, la API ni gcloud de Apigee. Para gestionar los recursos de las implementaciones de archivos mediante Apigee en VS Code, consulta Gestionar recursos.

Consulta y gestiona los recursos, tal como se describe en las siguientes secciones.

Acerca de los recursos

Muchos tipos de políticas se basan en recursos. Los recursos son los archivos que implementan el código o la configuración que debe ejecutar una política cuando se adjunta a un proxy de API. En algunos casos, como con JavaScript y JavaCallout, una política simplemente define un punto de acoplamiento en un proxy de API donde se debe ejecutar algún código. La política JavaScript o JavaCallout es un puntero a un recurso.

Tipos de recursos

En la siguiente tabla se resumen los tipos de recursos:

Tipo de recurso	Descripción
GraphQL (graphql)	Archivo de esquema de GraphQL al que hacen referencia las políticas de GraphQL.
JAR (java)	Clases de Java en un archivo JAR al que hacen referencia las políticas JavaCallout.
JavaScript (js)	JavaScript al que hacen referencia las políticas de JavaScript.
JavaScript (jsc)	JavaScript compilado al que hacen referencia las políticas de JavaScript.
OpenAPI Specification (oas)	Especificación de OpenAPI que se usa para validar mensajes de solicitud y respuesta de tipo JSON o YAML.
Property Set (properties)	Colección de pares clave/valor a los que se puede hacer referencia en los conjuntos de propiedades de un proxy de API.
Python (py)	Secuencias de comandos de Python a las que hacen referencia las políticas de PythonScript. Los recursos deben implementarse en "Python puro" (solo en el lenguaje Python).
Security policy (securityPolicy)	Política de seguridad personalizada a la que hacen referencia las políticas JavaCallout.
WSDL (wsdl)	Archivos WSDL a los que hacen referencia las políticas SOAPMessageValidation.
XSD (xsd)	Esquemas XML a los que hacen referencia las políticas SOAPMessageValidation.
XSL Transformations (xsl)	Transformaciones XSLT a las que hacen referencia las políticas XSLTransform.

Dónde se almacenan los recursos

Puedes almacenar recursos en las siguientes ubicaciones. No puedes almacenar archivos de recursos en una organización.

• Revisión del proxy de API: los recursos solo están disponibles para las revisiones del proxy de API en las que se incluyen. Por ejemplo, puedes incluir un recurso de JavaScript con la revisión 1 de un proxy de API y, a continuación, cambiar la implementación para usar una secuencia de comandos de Python en la revisión 2 del proxy. La revisión 1 solo tiene acceso al recurso de JavaScript, mientras que la revisión 2 solo tiene acceso al recurso de Python.
  Nota: En la interfaz de usuario, los recursos cuyo ámbito es una revisión de un proxy de API se muestran en la sección Recursos del panel de navegación, independientemente de si los has añadido con la interfaz de usuario o con la API.
• Entorno: cuando se almacenan en un entorno (por ejemplo, test o prod), los recursos están disponibles para cualquier proxy de API implementado en el mismo entorno.

El repositorio de entornos está disponible en el siguiente URI, tal como se describe en la API de archivos de recursos List y más adelante en Gestionar recursos con la API: /organizations/$ORG/environments/$ENV/resourcefiles

Nota: No puede ver el repositorio de recursos de revisión del proxy de la API mediante la API.

En la siguiente tabla se muestran los métodos que puede usar para crear, actualizar y eliminar recursos de cada repositorio:

Repositorio	Crear		Ver		Actualizar		Eliminar
	API	Interfaz	API	Interfaz	API	Interfaz	API	Interfaz
Revisión de proxy de API
Entorno

Por ejemplo, todos los archivos JavaScript disponibles en el entorno test se almacenan en el siguiente repositorio y están disponibles para cualquier proxy de API que se ejecute en el entorno test:

/organizations/$ORG/environments/test/resourcefiles/jsc

Resolución de nombres de recursos

Resuelve los nombres de los recursos del ámbito más específico al más general. Los nombres de los recursos se resuelven "hacia arriba", desde el nivel de revisión del proxy de API hasta el nivel del entorno.

Supongamos que has rellenado el mismo recurso en dos repositorios diferentes: la revisión del proxy de API y el entorno prod.

Supongamos que tiene un proxy de API configurado con la siguiente política:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

La referencia de la política no puede resolverse explícitamente en un repositorio. Se resuelve el primer recurso del ámbito más granular cuyo nombre coincida con el nombre del recurso de la política.

Por lo tanto, cuando el proxy de API se despliegue en el entorno prod, la política se resolverá en el recurso pathSetter.js con ámbito de entorno.

Cuando se implementa en el entorno test, la política se resolverá en el recurso de ámbito de revisión del proxy de API, ya que el recurso de ámbito de entorno está en el entorno prod, no en el entorno test.

Directrices de recursos de Java

Puedes añadir recursos de Java compilados como archivos JAR con varias opciones de curl, como -T, --data-binary o -F (no la opción -d). Por ejemplo:

curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  --data-binary @{jar_file}

curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  -T "{jar_file}"

curl "http://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles?name={jar_file}&type=java" \  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/octet-stream" \
  -F "file=@{jar_file}"

Nota: Nombres de paquetes: no uses io.apigee ni com.apigee como nombres de paquetes en las políticas JavaCallout. Están reservados y los usan otros módulos de Apigee.

Consulta también:

• Prácticas recomendadas de Java: prácticas recomendadas para el diseño y el desarrollo de proxies de API
• Ejemplo de libro de recetas de Java: política de transformación XSL

Gestionar recursos mediante la interfaz de usuario

Gestiona los recursos cuyo ámbito sea una revisión de proxy de API mediante la interfaz de usuario, tal como se describe en las siguientes secciones.

Nota: No puedes gestionar recursos cuyo ámbito sea una organización o un entorno mediante la interfaz de usuario. En su lugar, debes usar la API.

Ver recursos mediante la interfaz de usuario

Apigee en la consola de Cloud

1. En la Google Cloud consola, ve a la página Desarrollo de proxy > Proxies de API.

   Ir a proxies de API

2. Selecciona el proxy de API cuyos recursos quieras ver. Se muestra la vista Descripción general del editor de proxy.

3. Haz clic en la pestaña Desarrollar.
4. En el panel de navegación, desplázate hacia abajo hasta Recursos. Los recursos actuales se muestran debajo.

Interfaz clásica

Para ver los recursos definidos en una revisión de un proxy de API con el editor de proxies clásico, haz lo siguiente:

1. Inicia sesión en la interfaz de usuario de Apigee.
2. En la barra de navegación de la izquierda, selecciona Desarrollar > Proxies de API.
3. Selecciona un proxy de API de la lista para el que quieras crear un recurso.
   Se abre el editor de proxy de API y se muestra la pestaña Vista general de forma predeterminada.
4. Haz clic en la pestaña Desarrollar.
5. Selecciona la revisión en el menú desplegable Revisión, si es necesario.

   Los recursos definidos en el ámbito de la revisión del proxy de API se muestran en la sección Recursos de la vista Navegador.

Crear un recurso con la interfaz de usuario

Apigee en la consola de Cloud

Para crear un recurso con la consola de Apigee en Cloud, sigue estos pasos :

1. En la Google Cloud consola, ve a la página Desarrollo de proxy > Proxies de API.

   Ir a proxies de API

2. Selecciona el proxy de API cuyos recursos quieras ver. Se muestra la vista Descripción general del editor de proxy.

3. Haz clic en la pestaña Desarrollar.
4. En el panel de navegación, desplázate hacia abajo hasta Recursos y haz clic en el botón + situado a la derecha.
5. En el cuadro de diálogo Añadir recurso, introduce lo siguiente:
   • Tipo de recurso: selecciona el tipo de archivo del recurso.
   • En Fuente, selecciona Crear un archivo o Importar archivo. Si eliges Importar archivo, selecciona también un archivo que importar en el campo Archivo.
   • Nombre del recurso: escriba un nombre para el recurso.
6. Haz clic en Añadir.

Apigee Classic

Para crear recursos con el ámbito de una revisión de proxy de API mediante la interfaz de usuario clásica de Apigee, sigue estos pasos:

1. Consulta los recursos incluidos en el ámbito de la revisión del proxy de API.
2. Haz clic en + en la sección Recursos de la vista Navegador para abrir el cuadro de diálogo Nuevo recurso.
3. Introduce lo siguiente:

   Campo	Descripción
   Fuente	Selecciona la opción para crear un archivo o importar uno.
   Tipo de archivo	Seleccione un tipo de recurso en la lista desplegable.
   Nombre del archivo	Nombre del archivo. La extensión del nombre de archivo debe ser válida para el tipo de archivo seleccionado.

Actualizar un recurso mediante la interfaz de usuario

Actualiza un recurso cuyo ámbito sea una revisión de un proxy de API solo si la revisión no se ha implementado. Una vez que se ha implementado una revisión de un proxy de API, es inmutable.

Para actualizar un recurso cuyo ámbito sea una revisión de un proxy de API mediante la interfaz de usuario, sigue estos pasos:

1. Consulta los recursos incluidos en el ámbito de la revisión del proxy de API.
2. En la vista Navegador, en Recursos, haz clic en el recurso que quieras actualizar.
   Nota: En el caso de los archivos JAR, coloca el cursor sobre el recurso que quieras editar y haz clic en .
3. Actualiza el recurso según sea necesario.
   Nota: Después de subir un nuevo archivo JAR, haga clic en Actualizar.

Eliminar un recurso mediante la interfaz de usuario

Elimina un recurso cuyo ámbito sea una revisión de un proxy de API solo si la revisión no se ha implementado. Una vez que se ha implementado una revisión de un proxy de API, es inmutable.

Para eliminar un recurso cuyo ámbito sea una revisión de un proxy de API mediante la interfaz de usuario, sigue estos pasos:

1. Consulta los recursos incluidos en el ámbito de la revisión del proxy de API.
2. En la vista Navegador, en Recursos, coloca el cursor sobre el recurso que quieras eliminar para que se muestre el menú de acciones.
3. Haz clic en .
4. Haz clic en Eliminar para confirmar la acción.

Gestionar recursos con la API

Gestiona los recursos mediante la API, tal como se describe en las siguientes secciones.

Crear recursos con la API

Crea recursos cuyo ámbito sea una revisión de proxy de API o un entorno, como se describe en las siguientes secciones.

Crear recursos con ámbito en una revisión de un proxy de API mediante la API

Crea recursos que estén acotados a una revisión de proxy de API mediante la API, tal como se describe en las siguientes secciones.

Nota: Solo puedes crear un recurso que esté acotado a una revisión de proxy de API si la revisión no se ha implementado. Una vez que se ha implementado una revisión de un proxy de API, es inmutable.

Para crear un recurso cuyo ámbito sea una revisión de un proxy de API mediante la API, sigue estos pasos:

1. Crea el archivo de recursos.
2. Añade el archivo de recursos a un paquete de configuración de proxy de API.
3. Sube el paquete mediante una de las siguientes APIs:
   • Crear un proxy de API
   • Actualizar la revisión de un proxy de API

Crear recursos con ámbito en un entorno mediante la API

Crea recursos cuyo ámbito sea un entorno mediante la API enviando una solicitud POST al siguiente recurso: /organizations/$ORG/environments/$ENV/resourcefiles

Incluye la siguiente información en tu solicitud:

• Asigna al parámetro de consulta name el nombre del recurso.
• Asigna al parámetro de consulta type el tipo de recurso necesario.
• Transfiere el contenido del archivo de recursos como application/octet-stream o multipart/form-data.

Nota: Cuando importes un archivo de recursos mediante la API, puede que tengas que chmod los permisos del archivo para que tu herramienta de desarrollo (como curl) pueda subirlo.

En el siguiente ejemplo se muestra cómo crear un recurso de JavaScript pasando su contenido en el cuerpo de la solicitud.

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

En el siguiente ejemplo se muestra cómo subir el recurso como un archivo desde tu máquina local. Es importante usar -F para la subida binaria en curl para que los archivos JavaScript con ámbito de organización o de entorno sean accesibles mediante la política de JavaScript.

curl -X POST https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles?name=pathSetter.js&type=jsc
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

A continuación, se muestra un ejemplo de la respuesta:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Nota: Cuando utilices un cliente REST, como Postman:

• Define Content-Type en multipart/form-data.
• Adjunta la secuencia de comandos como un archivo.

Ver recursos mediante la API

En las siguientes secciones se describe cómo ver recursos mediante la API.

Ver todos los recursos mediante la API

Consulta todos los recursos de un entorno mediante la API, tal como se describe en las siguientes secciones.

Con la API, solo puedes ver los recursos que se han definido para un entorno.

Para ver todos los recursos de un entorno mediante la API, envía una solicitud GET al siguiente recurso: https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles

En el siguiente ejemplo se muestran todos los recursos del entorno test:

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles
  -H "Authorization: Bearer $TOKEN"

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

Para obtener más información, consulte la API List environment resource files.

A continuación, se muestra un ejemplo de la respuesta.

{
  "resourceFile": [
{
  "name" : "pathSetter.js",
  "type" : "jsc"
}
  ]
}

Ver el contenido de un recurso con la API

Para ver el contenido de un recurso en un entorno mediante la API, envía una solicitud GET al siguiente recurso: /organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

En el siguiente ejemplo se muestra el contenido del archivo pathSetter.js JavaScript (jsc) en el entorno test:

curl -X GET https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN"

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación, se muestra un ejemplo de la respuesta:

request.headers["RequestPath"] = context.getVariable("proxy.basepath");

Actualizar recursos mediante la API

Actualice los recursos cuyo ámbito sea una revisión de proxy de API o un entorno, tal como se describe en las siguientes secciones.

Actualizar recursos de una revisión de un proxy de API con la API

Nota: Solo puedes actualizar un recurso que esté asociado a una revisión de un proxy de API ya disponible si la revisión no se ha desplegado. Una vez que se ha implementado una revisión de un proxy de API, es inmutable.

Para actualizar un recurso cuyo ámbito sea una revisión de un proxy de API mediante la API, sigue estos pasos:

1. Descarga el paquete de configuración del proxy de API mediante la API Get API proxy revision con las siguientes opciones:
   • Asigna el valor bundle al parámetro de consulta format.
   • Asigna el valor application/zip al encabezado Accept.
2. Actualiza el archivo de recursos en el paquete de configuración del proxy de API.
3. Sube el paquete de configuración del proxy de API mediante la API Update API proxy revision.

Actualizar recursos de un entorno mediante la API

Para actualizar un recurso cuyo ámbito sea un entorno mediante la API, envía una solicitud PUT al siguiente recurso: /organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

Transfiere el contenido del archivo de recursos como application/octet-stream o multipart/form-data.

Nota: Cuando importes un archivo de recursos mediante la API, puede que tengas que chmod los permisos del archivo para que tu herramienta de desarrollo (como curl) pueda subirlo.

En el siguiente ejemplo se muestra cómo actualizar un recurso de JavaScript pasando su contenido en el cuerpo de la solicitud.

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:application/octet-stream" \
  -d 'request.headers["RequestPath"] = context.getVariable("proxy.basepath");'

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

En el siguiente ejemplo se muestra cómo actualizar el archivo de recursos con un archivo de tu máquina local. Es importante usar -F para la subida binaria en curl para que los archivos JavaScript con ámbito de organización o de entorno sean accesibles mediante la política de JavaScript.

curl -X PUT https://apigee.googleapis.com/v1/organizations/myorg/environments/test/resourcefiles/jsc/pathSetter.js
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type:multipart/form-data" \
  -F file=@pathSetter.js

A continuación, se muestra un ejemplo de la respuesta:

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Eliminar recursos mediante la API

Elimina recursos con ámbito en una revisión de proxy de API o un entorno, tal como se describe en las siguientes secciones.

Eliminar recursos de una revisión de un proxy de API mediante la API

Nota: Puedes eliminar un recurso cuyo ámbito sea una revisión de un proxy de API si no se ha implementado. Una vez que se ha implementado una revisión de un proxy de API, es inmutable.

En el caso de las configuraciones híbridas, para eliminar un recurso cuyo ámbito sea un proxy de API mediante la API, sigue estos pasos:

1. Descarga el paquete de configuración del proxy de API mediante la API Get API proxy revision con las siguientes opciones:
   • Asigna el valor bundle al parámetro de consulta format.
   • Asigna el valor application/zip al encabezado Accept.
2. Elimina el archivo de recursos del paquete de configuración del proxy de API.
3. Sube el paquete de configuración del proxy de API mediante la API Update API proxy revision.

Eliminar un recurso de un entorno mediante la API

Elimina un recurso con ámbito de un entorno mediante la API, tal como se describe en las siguientes secciones.

Para eliminar un recurso cuyo ámbito se limita a un entorno mediante la API, envía una solicitud DELETE al siguiente recurso: https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/resourcefiles/$TYPE/$NAME

En el siguiente ejemplo se elimina el archivo de recursos de JavaScript pathSetter.js del entorno test:

curl -X DELETE https://apigee.googleapis.com/v1/organizations/my-organization/environments/test/resourcefiles/jsc/pathSetter.js \
  -H "Authorization: Bearer $TOKEN"
  

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

Para obtener más información, consulte la API Delete resource file.

A continuación, se muestra un ejemplo de la respuesta.

{
  "name" : "pathSetter.js",
  "type" : "jsc"
}

Acceder al recurso

La forma de acceder al recurso depende del tipo de recurso. Para obtener más información, consulta el resumen de la referencia de las políticas.

En los ejemplos de esta sección se muestra cómo crear y gestionar un recurso de JavaScript llamado pathSetter.js para que las políticas de tipo JavaScript puedan hacer referencia a él.

Para adjuntar el archivo JavaScript a Request PostFlow, crea una política llamada PathSetterPolicy.xml que haga referencia al archivo pathSetter.js:

<Javascript name='PathSetterPolicy' timeLimit='200'>
    <ResourceURL>jsc://pathSetter.js</ResourceURL>
</Javascript>

A continuación, haz referencia a la política en la configuración de Endpoint:

<PostFlow>
  <Request>
    <Step><Name>PathSetterPolicy</Name></Step>
  </Request>
<PostFlow>

Para obtener más información, consulta la política de JavaScript.