OPTIONS

gistfile1.txt

- Todos los campos de texto soportarán markdown


Estructura General:
{
  name: "", //nombre del recurso
  description: "", //descripción general del recurso
  considerations: [], //consideraciones a tener en cuenta. es un array de strings. pueden ser reglas de negocio, etc.
  attributes: {}, // información de los atributos
  methods: {}, //métodos permitidos y ejemplos de cosas que se pueden hacer con cada uno
  connections: {}, //reglas para unir campos del JSON con otros recursos
  related_resources: [] //recursos relacionados a este, que el usuario podría estar interesado
}


Estructura de Attributes:
{
  "id": "", //Puede ser sólo un texto, que sería el description, o también un objeto
  "id": {}
}

Estructura de un Attribute:
{
  "description": "", //texto que indica qué es el attribute
  "required": true, //boolean que indica si es obligatorio o no
  "attributes": {}, //esto indicaría que el attribute es un objeto y tiene sus attributes
  "values": [] //valores que puede tomar el campo
}

Estructura de Methods:
{
  "GET": [] //array con ejemplos de GET
}

Estructura de un Ejemplo:
{
  "url": "/items/:id", //url del ejemplo
  "description": "", //descripción del ejemplo,
  "example": "" //ejemplo usando curl
}

Lo unico que se me ocurre es plantear el ejemplo de tal forma que sea facilmente reconfigurable a distintos lenguajes