RAML
El lenguaje de modelado de API de RESTful (RAML) es un lenguaje basado en YAML que describe las API de RESTful. RAML también proporciona capacidades para documentar ampliamente una API de RESTful, activar las herramientas de generador de documentación para extraer la documentación del usuario y, a continuación, traducirla a formatos visuales, tales como PDF, HTML, etcétera.
La acción RAML se utiliza para acceder a las API y realizar llamadas de API a los servicios para los que se crean las API mediante RAML. La acción RAML soporta la versión 0.8 de especificación de RAML.
Realice los siguientes pasos para utilizar la acción RAML en el flujo de trabajo:
1. Pulse en y arrastre la acción RAML que aparece en Diseño de la API al lienzo, coloque el puntero sobre la acción y pulse en o pulse dos veces en la acción. Se abre la ventana RAML.
2. Si fuera necesario, modifique el valor de Rótulo. Por defecto, el nombre de rótulo es igual que el nombre de acción.
3. En el campo URL de fichero raíz, introduzca el URL para extraer el fichero comprimido en el que se incluye el fichero RAML raíz y sus dependencias.
4. En el campo Nombre de fichero raíz, introduzca el nombre del fichero raíz RAML que desea extraer.
5. Pulse en Extraer para obtener todas las API definidas en el fichero RAML.
En la lista Solicitud de API se proporciona una lista de las API definidas en el fichero RAML.
6. En la lista Solicitud de API, seleccione una API.
En función de la API seleccionada, puede que sea necesario proporcionar detalles adicionales.
7. Pulse en Terminado.
Esquema de salida
¿Fue esto útil?