Creación de una definición de API
Puede crear definiciones de API mediante API Designer o la interfaz de línea de comandos en IBM® API Connect.
Antes de empezar
Una API es un conjunto de funciones que proporcionan prestaciones empresariales o técnicas que las aplicaciones pueden llamar utilizando un protocolo definido. Las aplicaciones son normalmente aplicaciones de móvil o web utilizan el protocolo HTTP. Una definición de API se compone de vías de acceso y puede ser uno de los tipos siguientes:
- Definición de API REST
Una API REST es un conjunto de interacciones definido que utiliza el protocolo HTTP, normalmente mediante JSON o XML como los formatos de datos que se intercambian. Por ejemplo, una solicitud de datos puede utilizar un método HTTP GET y un registro de datos puede utilizar un método HTTP POST. La elección del formato de datos depende del tipo de la aplicación que está llamando a la API. JSON se utiliza habitualmente para páginas web o aplicaciones móviles que presentan una interfaz de usuario (mediante JavaScript o HTML), mientras que XML suele emplearse para escenarios de máquina a máquina.
Puede exponer y proteger las API existentes utilizando una política Proxy o Invoke .
En cualquier caso, puede configurar la definición de API utilizando API Designer, o escribiendo un archivo de definición OpenAPI y publicándolo utilizando API Designer o la interfaz de línea de mandatos.
- API SOAP
Puede crear definiciones de API SOAP basadas en un archivo WSDL (Web Services Description Language) existente. Puede utilizar este recurso para beneficiarse de las prestaciones proporcionadas por, que incluyen análisis y correlación entre variables. También puede exponer la API utilizando el portal CMS para cualquier servicio SOAP existente en su organización, incluido cualquier servicio SOAP que forme parte de una arquitectura orientada a servicios (SOA) o de una infraestructura de bus de servicios empresariales (ESB).
Puede crear definiciones de API SOAP a través de la interfaz de línea de mandatos o a través de API Designer.
Acerca de esta tarea
Puede crear definiciones para las APIs REST o las APIs SOAP.
- En API Designer, puede añadir una definición de API REST componiendo la definición de API y sus operaciones, desde cero, o importando un archivo de definición de OpenAPI . También puede utilizar las herramientas para crear rápidamente una API de proxy que llame a un punto final existente.
- Si ya dispone de un servicio SOAP que desea exponer más ampliamente, puede añadir una API SOAP a IBM® API Connect. Puede utilizar el portal CMS para dar a conocer el servicio SOAP a los desarrolladores. Si un desarrollador desea utilizar la API SOAP, puede utilizar para gestionar su registro y acceso al servicio, y realizar un seguimiento del uso de dicha API.