Creación de una API REST

Editar en línea

Puede crear una API REST desde cero proporcionando la información básica, la información técnica y definiendo los recursos y métodos que necesite.

Acerca de esta tarea

Debe tener el privilegio funcional Gestionar API o activar/desactivar API para realizar esta tarea.

Procedimiento

  1. Abra el menú de opciones y seleccione APIs.
    Aparece una lista de todas las API existentes.
  2. Haga clic en Crear API.
  3. Seleccione Crear desde cero.
  4. Seleccione REST.
  5. Haga clic en Crear.
    Aparecerá la página Información básica del asistente Crear API REST.
  6. Proporcione la siguiente información en la sección Información básica.
    Campo Descripción
    Nombre Nombre de la API.
    Versión Versión de la API.
    Estado de vencimiento Estado de madurez de la API. Los valores disponibles son, Beta, Deprecated, Experimental, Production, Test.

    Los valores disponibles dependen de los estados de Madurez que estén configurados en la propiedad apiMaturityStatePossibleValues en la sección Administración > Configuración ampliada.
    Agrupación de API Grupo en el que puede clasificarse la API. Los valores disponibles son: Finanzas, Banca y Seguros, Ventas y Pedidos, Búsqueda y Transporte y Almacenamiento.

    Los valores disponibles dependen de los grupos que estén configurados en la propiedad apiGroupingPossibleValues en la sección Administración > Configuración ampliada.
    Etiquetas Palabras clave para clasificar, identificar y organizar las API. Seleccione de la lista de etiquetas existentes o cree etiquetas nuevas.
    Descripción Descripción de la API.
  7. Haga clic en Continuar para proporcionar información técnica para esta API.
    Nota: Haga clic en Guardar para guardar la API en esta fase y cerrar el asistente Crear API REST.
  8. Proporcione los detalles de los servidores que sirven la API en la sección Añadir detalles del servidor.
    1. Haga clic en Añadir servidor e indique un Servidor URL y una Descripción. Puede incluir variables en el servidor URL encerrándolas entre llaves. Estas variables se añaden a la lista de variables. Sin embargo, debe editar estas variables para añadir un valor por defecto. Puede añadir uno o varios valores y una descripción.
    2. Haga clic en Añadir variables y proporcione la información para los campos Nombre, Descripción, Predeterminado y Valor.
    Nota: Haga clic en + para añadir el valor creado. Haga clic en Añadir para añadir la variable.
  9. Haga clic en Añadir Parámetro y proporcione la información para añadir los parámetros a nivel de API como se indica a continuación.
    Campo Descripción
    Nombre Nombre del parámetro.
    Descripción Descripción del parámetro.
    Type Especifica el tipo de parámetro. Valores disponibles: Query-string, Header, Cookie.
    Tipo de datos Especifica el tipo de datos. Valores disponibles: String, Date, Date time, Integer, Double, Boolean, File.
    Obligatorio Seleccione la opción si necesita el parámetro.
    Repetir Seleccione la opción si el parámetro de entrada es de tipo array.
    Valor Especifica los valores posibles.
    Nota: Defina parámetros sólo para los datos que desee webMethods API Gateway procesar.
  10. Escriba un nombre para mostrar del Registro de servicios.
    Por defecto, la API aparece en los registros de servicios con el nombre APIName_Version. Si desea que la API aparezca en los registros de servicios con un nombre diferente, puede escribir el nombre aquí.
  11. Haga clic en Continuar para proporcionar recursos y métodos para esta API.
    Nota: Haga clic en Guardar para guardar la API en esta fase y cerrar el asistente Crear API REST
  12. Añada recursos a la API en la página Recursos y métodos.
    1. Haga clic en Añadir recursos y proporcione la siguiente información.
      Campo Descripción
      Nombre de recurso Nombre del recurso. El nombre que proporcione es el nombre para mostrar del recurso y la ruta del recurso que se utiliza para la ejecución.
      Vía de acceso de recurso Especifica la ruta del recurso. La ruta del recurso debe contener un "/".
      Descripción Descripción del recurso.
      Métodos soportados Seleccione los métodos que admite la API. Valores disponibles, GET, HEAD, POST, PUT, DELETE, PATCH.
    2. Pulse Añadir. Se añade el recurso. Puede añadir varios recursos.
    3. Añadir etiquetas.
    4. Haga clic en Añadir Parámetro de Recurso y proporcione la siguiente información.
      Campo Descripción
      Nombre Nombre del parámetro.
      Referencia Si desea reutilizar un parámetro global definido en la página Componentes, seleccione el parámetro en la lista.
      Descripción Breve descripción del parámetro.
      Tipo Especifica el tipo de parámetro. Valores disponibles, Path, Header, Query-string, Cookie.
      Tipo de datos Especifica el tipo de datos. Valores disponibles: String, Date, Date time, Integer, Double, Boolean, File.
      Obligatorio Seleccione la opción si necesita el parámetro.
      Repetir Seleccione la opción si el parámetro de entrada es de tipo array.
      Valor Especifica los valores posibles para el parámetro.
    5. Haga clic en + Añadir para añadir el parámetro del recurso.
  13. Para cada método admitido que se añada para un recurso, proporcione la información que se indica a continuación.
    1. Información común
      Campo Descripción
      Descripción Escriba una descripción de la operación.
      OperationId Escriba un ID de operación.
      Etiquetas Escriba o seleccione las palabras clave que desea añadir a la operación.
    2. Parámetros del método
      Campo Descripción
      Nombre Nombre del parámetro.
      Referencia Si desea reutilizar un parámetro global definido en la página Componentes, seleccione el parámetro de la lista.
      Descripción Breve descripción del parámetro.
      Tipo Especifica el tipo de parámetro. Valores disponibles: Query-string, Header, Cookie.
      Tipo de datos Especifica el tipo de datos. Valores disponibles: String, Date, Date time, Integer, Double, Boolean, File.
      Obligatorio Seleccione la opción si necesita el parámetro.
      Repetir Seleccione la opción si el parámetro de entrada es de tipo array.
      Valor Especifica los valores posibles para el parámetro.
    3. Peticiones. Puede seleccionar una solicitud global existente definida en la página Componentes o especificar una nueva solicitud.
      Para escribir una nueva solicitud, seleccione Nueva solicitud y facilite la siguiente información.

      • Tipo de contenido. Seleccione uno y haga clic en Añadir.

      • Esquema. Escriba un esquema en el cuadro de texto o seleccione un esquema existente en la lista Seleccionar un esquema. También puede hacer clic en Añadir esquema global y crear un nuevo esquema global en la página Componentes. Una vez creado el esquema global, puede seleccionarlo en la lista Seleccionar un esquema.

      • Muestra.Escriba una muestra para el esquema seleccionado. Utilice este ejemplo para simular APIs.

    4. Para utilizar una solicitud global existente para procesar una solicitud, seleccione Solicitud global y proporcione la siguiente información.

      • Nombre

      • Referencia. Seleccione uno y haga clic en Añadir.

    5. Respuestas. En primer lugar, añada un código de estado de la lista Código de estado.
      Haga clic en el código de estado para seleccionarlo. Para el código de estado, puede seleccionar una respuesta global existente que esté definida en la página Componentes o proporcionar una nueva respuesta. Para proporcionar una nueva respuesta, seleccione Nueva respuesta y defina la respuesta añadiendo un esquema y una muestra para el cuerpo de la respuesta, los parámetros de cabecera y los enlaces.
      Nota: También puede definir la respuesta para una serie de códigos de estado HTTP, como 2 o 4.

      Para definir una nueva respuesta para el código de estado seleccionado, haga clic en Añadir respuesta + y proporcione la información como se indica a continuación.

      • Tipo de contenido. Seleccione uno de los tipos de contenido disponibles y haga clic en Añadir.
      • Esquema. Escriba un esquema en el cuadro de texto o seleccione un esquema existente en la lista Seleccionar un esquema.

        También puede hacer clic en Añadir esquema global y crear un nuevo esquema global en la página Componentes. Una vez creado el esquema global, puede seleccionarlo en la lista Seleccionar un esquema.

      • Muestra. Escriba una muestra para el esquema seleccionado. Esta muestra se puede utilizar para API mocking.

      Para utilizar una respuesta global existente, seleccione Respuesta global y proporcione la siguiente información:

      • Nombre. Nombre de la respuesta.
      • Referencia. Seleccione uno y haga clic en Añadir.

      Para añadir un parámetro de cabecera, haga clic en + Añadir parámetro de cabecera y proporcione la siguiente información para añadir un parámetro de cabecera:

      • Nombre. Nombre del parámetro.
      • Referencia. Si desea reutilizar un parámetro global definido en la página Componentes, seleccione el parámetro en la lista.
      • Descripción. Breve descripción del parámetro.
      • Tipo. Especifica el tipo de parámetro. Valores disponibles, Cabecera.
      • Tipo de datos. Especifica el tipo de datos. Los valores disponibles son: String, Date, Date time, Integer, Double, Boolean, File.
      • Obligatorio. Seleccione la opción si necesita el parámetro.
      • Repite. Seleccione la opción si el parámetro de entrada es de tipo array.
      • Valor. Especifica los valores posibles para el parámetro.

      Haga clic en + en el cuadro de texto Valor para añadir un valor a la lista y haga clic en Añadir para añadir el encabezado.

      Para añadir un enlace, haga clic en + Añadir enlaces y proporcione la siguiente información para añadir un enlace.

      • Nombre. Nombre del enlace
      • Descripción. Descripción del enlace.
      • Enlace. Puede añadir un enlace o seleccionar un enlace global existente que esté definido en la página Componentes.

      Para añadir un enlace, seleccione Nuevo enlace y facilite la siguiente información.

      • Tipo. Seleccione OperationId para operaciones locales. Puede utilizar OperationRef tanto para operaciones locales como externas.
      • Valor. Si Type es OperationRef, proporcione una referencia a la operación de destino utilizando la sintaxis de referencia JSON \(using by the $ref keyword\). Si el Tipo es OperationId, proporcione el ID de operación de la operación de destino.
      • Parámetros. Especifique los parámetros de la operación de destino que necesita para seguir el enlace. Introduzca un Nombre y un Valor y haga clic en Añadir.
      • Cuerpo de la solicitud. Proporcione un cuerpo de solicitud sólo si la operación de destino tiene un cuerpo. Define el contenido del cuerpo de la operación de destino.

      Para incluir un enlace global existente, seleccione Enlace global y, a continuación, seleccione un enlace global existente de la lista Referencia.

    6. Devoluciones de llamada. Puede añadir las llamadas de retorno que admite el método. Puede añadir nuevas retrollamadas y seleccionar las retrollamadas globales existentes.
      Para especificar una nueva llamada de retorno, haga clic en + Añadir llamadas de retorno y defina la llamada de retorno:
      • Nombre. Un nombre para el recurso de devolución de llamada.
      • Haga clic en + Añadir recursos y proporcione los detalles de la API que sirve como API de devolución de llamada.
      Nota: La interfaz de usuario y el procedimiento para definir una devolución de llamada es similar a la definición de un recurso y los métodos dentro del recurso.

      Para incluir una llamada de retorno global definida en la página Componentes, proporcione la siguiente información.

      • Nombre. Nombre del recurso de devolución de llamada.
      • Referencia. Si desea reutilizar una llamada de retorno global definida en la página Componentes, seleccione la llamada de retorno de la lista y haga clic en Añadir.
  14. Haga clic en Continuar para proporcionar información de Mocking para esta API.
    Nota: Haga clic en Guardar para guardar la API en esta fase y cerrar el asistente Crear API REST. Aparecerá la página API mocking. La simulación de API no está habilitada para una nueva API. Edite la API y active la simulación de API después de crear la API.
  15. Haga clic en Continuar para definir los componentes de esta API. También puede hacer clic en Componentes.
    Nota: Haga clic en Guardar para guardar la API en esta fase y cerrar el asistente Crear API REST
  16. Defina los elementos reutilizables que desea reutilizar en otras páginas del asistente Crear API REST. Una API puede tener varios elementos comunes a todos los recursos y métodos, como los esquemas de los cuerpos de respuesta. Puede colocar estos elementos comunes en la sección Componentes y hacer referencia a ellos utilizando el alias $ref .
    1. En la sección Esquemas, haga clic en + Añadir esquema y proporcione la siguiente información.
      Campo Descripción
      Nombre Nombre del esquema.
      Tipo de esquema Especifica el tipo de esquema. Los tipos disponibles son: esquema en línea y esquema externo.
      Valor Especifica el valor del tipo de esquema seleccionado.

      Para un esquema en línea, escriba los valores de solicitud y respuesta.

      Para un esquema externo, haga clic en Examinar para cargar un esquema.

      Haga clic en + Añadir para añadir el componente de esquema.

    2. En la sección Parámetros, haga clic en + Añadir parámetro y proporcione la siguiente información.
      Campo Descripción
      Nombre Nombre del parámetro.
      Descripción Descripción del parámetro.
      Tipo Especifica el tipo de parámetro. Los valores disponibles son Path, Query-string, Header y Cookie.
      Tipo de datos Especifica el tipo de datos. Los valores disponibles son String, Date, Date time, Integer, Double, Boolean y File.
      Obligatorio Seleccione la opción si necesita el parámetro.
      Repetir Seleccione la opción si el parámetro de entrada es de tipo array.
      Valor Especifica los valores posibles para el parámetro.

      Haga clic en + Añadir para añadir el componente de parámetros.

    3. En la sección Encabezados, haga clic en + Añadir encabezado y proporcione la siguiente información.
      Campo Descripción
      Nombre Nombre de la cabecera.
      Descripción Descripción de la cabecera.
      Tipo Especifica el tipo de cabecera. El valor se fija en Header para las cabeceras.
      Tipo de datos Especifica el tipo de datos. Los valores disponibles son String, Date, Date time, Integer, Double, Boolean y File.
      Obligatorio Seleccione la opción si desea la cabecera.
      Repetir Seleccione la opción si el parámetro de entrada es de tipo array.
      Valor Especifica los valores posibles para la cabecera.

      Haga clic en + Añadir para añadir el componente de cabecera.

    4. En la sección Ejemplos, haga clic en + Añadir ejemplos y proporcione la siguiente información.
      Campo Descripción
      Nombre Nombre del ejemplo.
      Resumen Descripción del ejemplo.
      Valor El contenido del ejemplo.

      Haga clic en + Añadir para añadir el componente de ejemplo.

    5. En la sección Enlaces, haga clic en + Añadir enlaces y facilite la siguiente información.
      Campo Descripción
      Nombre Nombre del enlace.
      Descripción Descripción del enlace.
      Tipo Especifica el tipo de enlace. Los valores disponibles son, OperationiD, OperationRef.
      Valor Especifica una ruta a la operación de destino o una referencia a la operación de destino.
      Nombre de parámetro Especifica el nombre del parámetro que se pasa como parámetro a la operación de destino.
      Valor del parámetro Valor del parámetro. Haga clic en + Añadir para añadir el parámetro. Puedes añadir más parámetros.
      Cuerpo de solicitud Carga útil de la solicitud enviada a la operación de destino.

      Haga clic en Añadir para añadir el componente de enlace.

    6. En la sección Devoluciones de llamada, haga clic en + Añadir devolución de llamada y proporcione la siguiente información.
      • Escriba un nombre para la llamada de retorno.
      • Haga clic en + Añadir recursos.
      • Escriba la ruta de Callback.
      • Seleccione los métodos admitidos.
      • Pulse Añadir.
      • Para cada método que añada, complete los dos pasos siguientes.
      • Haga clic en + Añadir parámetro de recurso y añada los parámetros de recurso que necesite. El procedimiento para añadir parámetros de recursos se indica en el paso 11d.
      • Definir los métodos seleccionados. El procedimiento para definir los métodos se describe en el paso 12.
    7. En la sección Órganos de solicitud, haga clic en + Añadir solicitud y facilite la siguiente información.
      Campo Descripción
      Nombre Nombre de la solicitud.
      Tipo de contenido Seleccione un tipo de contenido de la lista.
      Esquema También puede seleccionar un esquema existente.
      Ejemplo Escriba una muestra del esquema.

      Haga clic en Añadir para añadir el componente de solicitud.

    8. En la sección Respuestas, haga clic en + Añadir respuesta y proporcione la siguiente información.
      Campo Descripción
      Nombre Nombre de la respuesta.
      Tipo de contenido Haga clic en Añadir para añadir un tipo de contenido.
      Esquema También puede seleccionar un esquema existente.
      Ejemplo Escriba una muestra del esquema.
      Parámetro de cabecera Haga clic en + Añadir parámetro de cabecera y proporcione la información que necesite. A continuación, haga clic en + Añadir para añadir el parámetro de cabecera.
      Enlaces Haga clic en + Añadir enlaces y proporcione la información que necesite. A continuación, haga clic en Añadir para añadir el enlace.

      Haga clic en Añadir para añadir el componente de respuesta.

  17. Haga clic en Continuar para proporcionar documentos de API para esta API >.
    Aparece la página Documentación.
    Nota: Haga clic en Guardar para guardar la API en esta fase y cerrar el asistente Crear API REST.
  18. Escriba un nombre para la pantalla y haga clic en Examinar para seleccionar un archivo.
  19. Haga clic en + Añadir para cargar el archivo y añadir una fila.
  20. Haga clic en Guardar para guardar los cambios y crear la API.