feat(banks): adiciona busca por nome, código ou ISPB em /banks/v1 by Gabriel-Richard-dev · Pull Request #927 · BrasilAPI/BrasilAPI · GitHub
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 44 additions & 1 deletion pages/api/banks/v1/index.js
43 changes: 42 additions & 1 deletion pages/docs/doc/bank.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,34 @@
"get": {
"tags": ["BANKS"],
"summary": "Retorna informações de todos os bancos do Brasil",
"description": "Retorna uma lista com os dados de todos os bancos. Exemplo de uso: `GET https://brasilapi.com.br/api/banks/v1`.",
"description": "Retorna uma lista com os dados de todos os bancos. Use o parâmetro opcional `search` para filtrar por trecho do nome (sem diferenciar maiúsculas e acentos), código bancário ou ISPB. Exemplos de uso: `GET https://brasilapi.com.br/api/banks/v1` e `GET https://brasilapi.com.br/api/banks/v1?search=inter`.",
"parameters": [
{
"name": "search",
"in": "query",
"description": "Termo de busca (1 a 100 caracteres). Textos são comparados com `name` e `fullName` ignorando maiúsculas e acentos; termos numéricos são comparados com `code` (igualdade) e `ispb` (trecho). Sem resultados, retorna lista vazia.",
"required": false,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"examples": {
"nome": {
"summary": "Trecho do nome",
"value": "pagamentos"
},
"codigo": {
"summary": "Código bancário",
"value": "260"
},
"ispb": {
"summary": "ISPB",
"value": "18236120"
}
}
}
],
"responses": {
"200": {
"description": "Success",
Expand All @@ -32,6 +59,20 @@
]
}
}
},
"400": {
"description": "O parâmetro search é inválido",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorMessage"
},
"example": {
"message": "O parâmetro search deve ser um texto entre 1 e 100 caracteres",
"type": "BANK_SEARCH_INVALID"
}
}
}
}
}
}
Expand Down
87 changes: 87 additions & 0 deletions tests/banks-v1.test.js
Loading