Crear, Editar y Eliminar APIs

Para crear una nueva API manualmente, puede hacer clic en el botón Create API, representado por el icono + en la esquina inferior derecha de la pantalla. Si simplemente deja el cursor sobre el botón, aparecen otras tres opciones:

En total, por lo tanto, tiene estas cuatro formas de crear una API:

Después de elegir una de las opciones anteriores, se mostrará la pantalla de registro y se deberán rellenar los campos requeridos (a menos que decida importar un archivo Swagger, que ya crea la API, con la posibilidad de editar los campos). La pantalla de registro manual de la API es esta:

Si un entorno ya está registrado en Environments, se muestra la opción Deployable Environments. De lo contrario, el entorno se puede agregar más adelante (leer más sobre esto en esta sección).

La opción Access token expires in determina el período de tiempo de caducidad de tokens para una API determinada. Si no establece un valor, el tiempo predeterminado (10 segundos) es válido.

La opción Context está relacionada con la visibilidad de su API, que solo se mostrará a los usuarios autorizados. Las opciones son:

Se mostrarán todos los usuarios existentes en el API Manager. Para cambiar el permiso de un usuario específico, simplemente elija entre las opciones Can view (puede ver) o Can edit (puede editar).

Aunque la opción Can edit concede al usuario seleccionado permiso para editar la información de la API, este permiso no superará las reglas de acceso definidas en la configuración de rol de ese usuario.

La opción Private API, cuando está activada, no permite que la API esté disponible para su consumo en el Portal de Desarrolladores.

Al hacer clic en Save and next, se guardarán los datos básicos de la API. Los dos pasos siguientes (Resources y Flows) no son obligatorios (sin embargo, si la importación de un Swagger se había realizado anteriormente, los datos de recursos ya se completarán). Para más detalles, acceder a las páginas sobre Resources y Flows.

El último paso para crear la API es la pantalla Publish:

Es posible realizar el despliegue de la API en un entorno si la opción Environments fue seleccionada al inicio del registro. También puede crear plantillas de prueba, que generarán un plan y una aplicación vinculados a la API registrada. Esta opción le permitirá usar su API inmediatamente.

Una vez registradas, las APIs se organizan en tarjetas (lea más sobre ellas aquí).

Para acceder a la pantalla de edición y eliminación de API, hacer clic en la tarjeta de una API. Se le dirigirá a la pantalla Overview. La información puede editarse haciendo clic en el botón Edit. En la esquina inferior derecha, hay el botón Delete para eliminar la API. Consulte más información sobre la pantalla Overview aquí.

Puede crear APIs a partir de la importación de archivos de documentación que siguen la especificación OpenAPI. Las versiones admitidas de la especificación son: Swagger 2.0 u OpenAPI 3.0.0.

Para esto, sitúe el cursor sobre el botón + en la esquina inferior derecha de la pantalla APIs y haga clic en la opción IMPORT API DOCUMENT. Se abrirá la siguiente ventana modal:

Introduzca un nombre y una versión para la API que se creará y haga clic en SELECT FILE para elegir un archivo de su máquina para importar. Los formatos aceptados son JSON y YAML.