Un nombre de varias palabras, como la fecha de creación, se puede escribir de tres maneras en el documento. El paquete convierte por ti; en tu código siempre escribes snake_case.
Los tres estilos
La opción member_case (variable JSON_, por defecto camel) decide cómo se escriben los nombres de varias palabras en el documento:
| Valor | Cómo se escribe created_at | Ejemplo de orden |
|---|---|---|
camel | createdAt | sort=-createdAt |
kebab | created-at | sort=-created-at |
snake | created_at | sort=-created_at |
La especificación JSON:API 1.1 recomienda camelCase para los nombres de los miembros, y por eso es el valor por defecto. kebab y snake son una elección tuya, y el paquete los soporta igual.
Qué cambia y qué no
El estilo se aplica, en la entrada y en la salida, a:
- los atributos y las relaciones;
- los parámetros
sortyfields; - el
metade paginación (por ejemplocurrent-pageconkebab).
Los tipos, los id, los enlaces y los punteros de los errores no cambian con el estilo.
En tu código
Escribes siempre snake_case, como en Eloquent: 'created_at' => $this->created_at en el recurso, jsonApiSort(['created_at']) en el controlador. El paquete convierte el nombre al estilo configurado al responder, y el que llega del cliente a snake_case al leerlo. Si cambias de estilo, tu código no cambia.
JSON_API_MEMBER_CASE=kebab