agustincarmona/laravel-api-schema

Publish schema, for each public method of API controllers

0.1.1 2015-09-27 22:14 UTC

Requires

• php: >=5.3.0
• laravel/framework: ~4.1

MIT

• Agustín Carmona

• api
• schema
• restful
• controller
• laravel

README

Los que habéis usado servicios web de ASP.NET o Java estaréis familiarizados con el formato WSDL. El objetivo de este formato es devolver la estructura de datos de entrada y datos de salida para cada método del API. Esto es un útil porque te permite montar objetos o clases dinámicamente a partir del schema de un servicio web.

Pues bien, imaginar que estamos usando un API y queremos montar unos objetos para encapsular la respuesta del servicio web y trabajar esos datos. Nos tocaría hacer una transformación de esos datos en nuestra estructura de clases.

Ahora imaginar que podéis construir los modelos dinámicamente sólo consultando el schema del servicio web, esto nos ahorraría tener que buscar la documentación para ver la nueva estructura, implementar las nuevas propiedades en nuestros modelos y adaptar nuestra aplicación.

Instalación

$ composer require "agustincarmona/laravel-api-schema"

Cómo se usa

Añadir el trait APISchema\Http\Traits\SchemeTraitController en tú controlador.

class MyController extends Controller {
  use APISchema\Http\Traits\SchemeTraitController;

}

Crear una clase con los parámetros de entrada de cada acción del controlador.

class formInput extends InputModel {

  /**
  * Sample parameter 1
  * @var int
  **/
  public $id;

  /**
  * Sample parameter 2
  * @var string
  **/
  public $name;
  
    /**
     * @see \Validator
     * @return array
     */
    public function getValidator() {
        return [];
    }  

}

En cada acción del controlador añadir un comentario para definir la clase que contiene la definición de los datos de entrada del método.

    /**
     * @input formInput
     * @return mixed
     */
	public function postIndex()
	{
		return View::make('form');
	}