Diseñando y documentando tus APIs utilizando RAML

adrianalonso.es

web developer

¿Como diseñar una buena API?

• Utilizar RESTFul
• Elegir sistema de autenticación
• Documentar correctamente los endpoints
• Compromiso con el equipo de desarrollo
• Do IT Easy!

Beneficios de diseñar una buena API

• Control sobre el desarrollo del software
• Compromiso entre dueño del software y equipo de desarrollo
• Uso de buenas prácticas

¿Que es RAML ?

•  Acrónimo de “Restful Api Modeling Language” 
• Lenguaje de modelado para definir apis REST
• Se escribe en YAML y JSON Schema
• Permite definir recursos, métodos, parámetros, respuestas, tipos de medios y otros componentes HTTP básicos

¿Que es RAML?

•  Básicamente,  lo que nos permite es escribir la especificación de las apis siguiendo un estándar.

Esta metodología favorece el proceso de testing aportándonos el entorno perfecto para usar TDD. Básicamente, definimos la api, escribimos tests para consumir esa api y empezamos a construir la implementación real y necesaria para validar tanto los tests como la especificación descrita.

Alternativas

Get Starting

npm install -g api-designer

https://github.com/mulesoft/api-designer

Tools

• Raml JS Parser: https://github.com/raml-org/raml-js-parser
• Raml Java parser: https://github.com/raml-org/raml-java-parser
• SOAPUI Raml Plugin: https://github.com/SmartBear/soapui-raml-plugin

GRACIAS

http://adrianalonso.es/2016/06/disenando-y-documento-apis-utilizando-raml/