Configurar límites y api keys en Restler
Configurar límites y api keys en Restler



Esta va a ser una entrada rápida para ver lo sencillo que es poder documentar una Api con Restler utilizando Restler API Explorer.

La documentación de una Api es necesaria ya que de otra forma no sabremos que recursos ofrece nuestra Api, si tienes dudas con Restler te recomiendo los tutoriales anteriores donde explicamos todo lo necesario.

Lo primero que debemos hacer es ir al respositorio de Restler API Explorer y realizar la descarga, una vez lo hayamos descargado, simplemente debemos extraer el directorio dist en la raíz de nuestro proyecto, es decir, a la altura del index.php y cambiamos el nombre del directorio dist por explorer.

Una vez tengamos eso hecho, abre el archivo index.php y añade la siguiente línea, la cual habilita nuestra api a generar los recursos necesarios para la documentación.


Ahora vamos a simular la clase Users y la vamos a documentar con phpdoc para que Restler sepa interpretar dicha documentación, toda la información de las anotaciones la tienes aquí.


Para finalizar, sólo tienes que abrir la url http://localhost:8000/explorer/index.html y pulsar en este caso sobre users, verás que se desplega un menú con todos los métodos de la clase Users y cada uno de ellos documentado con lo que hemos escrito anteriormente.

api-explorer-restler