Closed nataliasou closed 1 year ago
get:
tags:
- localidades
summary: Lista todos os municipios brasileiros de um detrminado estado
operationId: getAllMunicipios
produces:
- application/json
parameters:
- name: codigo_estado
in: path
description: Código do estado que se deseja listar os municipios
required: true
type: string
responses:
200:
description: Operação realizada com sucesso.
schema:
$ref: '#/definitions/allMunicipios'
400:
description: Parâmetros incorretos
404:
description: Recurso não encontrado.
Modelo:
allMunicipios:
type: object
properties:
data:
type: array
items:
$ref: '#/definitions/DadosMunicipios'
total:
type: integer
result:
type: boolean
DadosMunicipios:
type: object
properties:
nm_cidade:
type: string
codigo_uf:
type: integer
codigo_cidade:
type: integer
estado:
type: string
API e documentação atualizada.
Exemplo de requisição: GET https://sete.transportesufg.eng.br/localidades/municipios/12 Resultado: • Retorno do HTTP está 200 (OK) • A documentação não possui resultado esperado • Está usando o seguinte formato • { ..., “total”: 0, result: "true" } Exemplo de requisição: GET https://sete.transportesufg.eng.br/localidades/municipios/0 Resultado: • Retorno do HTTP está 200 (OK) • A documentação não possui resposta esperada. • Está usando o seguinte formato { ..., “total”: 0, result: "true" } • O id não existe era para retornar 404 ou algum erro, verificar se é o correto com o Prof. Marcos e o Umarley. Exemplo de requisição: GET https://sete.transportesufg.eng.br/localidades/municpios/12 Resultado: • Retorno do HTTP está 404 - Not found • A documentação não possui resposta esperada. • Está usando o seguinte formato { result: "false", “messages”: “string” } Exemplo de requisição: POST https://sete.transportesufg.eng.br/localidades/municipios/12 Resultado: • Retorno do HTTP está 405 – Method not allowed • A documentação não possui resposta esperada. • Não retorna nenhuma mensagem como erro.