Tipos de Dados
Os parâmetros poderão ter os seguintes valores:
| Valor | Descrição |
|---|---|
| string | Uma cadeia de caracteres. Texto. |
| numeric | Um valor numérico. Pode ser um inteiro, decimal ou uma string que representa o número. |
| boolean | Um valor booleano ("true" ou "false"). |
| array | Uma lista de valores. |
| object | Um objeto (uma coleção de chave : valor); |
| mixed | Pode receber qualquer valor. Será especificado na descrição. |
| file | Um arquivo (enviado por um formulário). |
Tabelas
Tanto nas descrições dos parâmetros quanto das respostas, as chaves podem representar:
| Exemplo | Descrição |
|---|---|
| key | Se não for especificado, o valor será "escalar", ou seja, um texto ou número. |
| object.key | A chave "object" receberá um objeto e "key" é o valor descrito. |
| objects.*.key | O valor é uma lista de objetos, que terão a chave "key". |
| list.* | O valor é uma lista de valores sem chave. |
Por exemplo, todos os valores acima seriam:
{
"key": "some value",
"object": {
"key": "some value"
},
"objects": [
{
"key": "some value"
},
{
"key": "another value"
}
],
"list": [
"some value",
"another value",
"one more value"
]
}