umarley / seteAPI

BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Módulo localidades - GET - Lista todos os estados brasileiros #98

Closed nataliasou closed 1 year ago

nataliasou commented 2 years ago

image Exemplo de requisição: GET https://sete.transportesufg.eng.br/localidades/estados Resultado: • Retorno do HTTP é 200 (OK) • A documentação não possui resultado esperado • Está usando o seguinte formato { ..., “total”: 0, result: "true" } • Os ids dos estados não seguem uma ordem e os nomes dos estados não estão em ordem alfabética, verificar se é assim mesmo. image Exemplo de requisição: GET https://sete.transportesufg.eng.br/localidades/estads Resultado: • Retorno do HTTP é 404 – Not found • A documentação não possui resultado esperado • Está usando o seguinte formato { result: "false", “messages”: “string” } image

Exemplo de requisição: POST https://sete.transportesufg.eng.br/localidades/estados Resultado: • Retorno do HTTP é 405 – Method not allowed • A documentação não possui resultado esperado • Não retorna nenhuma mensagem

nataliasou commented 2 years ago

@umarley

get:
      tags:
      - localidades
      summary: Lista todos os estados brasileiros
      operationId: getAllEstados
      produces:
      - application/json
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/allEstados'
        400:
          description: Parâmetros incorretos
        404:
          description: Recurso não encontrado.

Modelo:

allEstados:
    type: object
    properties:
      data:
        type: array
        items:
          $ref: '#/definitions/DadosEstados'
      total:
        type: integer
      result:
        type: boolean
  DadosEstados:
    type: object
    properties:
      codigo:
        type: integer
      nome:
        type: string
      uf:
        type: string
umarley commented 1 year ago

Documentação e API atualizadas....