umarley / seteAPI

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

Módulo Rotas - GET - Listar todos os veículos associados a uma rota #131

Closed glcalil-ufg closed 1 year ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/5201405/73170/veiculos

Resultado do experimento:

  • Retorno do HTTP está 200 (OK)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ ..., total: <valor> }

  • Há campos do tipo _links, deve ser feito assim mesmo?

  • Há vários campos NULL, verificar se está correto.

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/5201409995/73170/veiculos

Resultado do experimento:

  • Retorno do HTTP está 404 (NOT FOUND)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ result: "false", messages : “...” }


Exemplo de requisição:

GET https://sete.transportesufg.eng.br/rotas/5201405/73179990/veiculos

Resultado do experimento:

  • Retorno do HTTP está 404 (NOT FOUND)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ link_to_object, result: "false" }

  • Deveria realmente voltar um link para um objeto?




glcalil-ufg commented 1 year ago

@umarley

get:
      tags:
      - rotas
      summary: Listar todos os veículos associados a uma rota
      operationId: getVeiculosByRota
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        description: Código do municipio que a rota pertence
        required: true
        type: integer
      - in: path
        name: id_rota
        description: ID da rota que se deseja consultar 
        required: true
        type: integer
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/RotaVeiculo'
        400:
          description: Parâmetros inválidos
        404:
          description: Veículos não encontrados
      security:
      - api_key: []

Modelo

RotaVeiculo:
    properties:
      id_rota:
        type: integer
      id_veiculo:
        type: integer
      codigo_cidade:
        type: integer
      nome:
        type: string
      km:
        type: number
      hora_ida_inicio:
        type: string
      hora_ida_termino:
        type: string
      da_porteira:
        type: string
      da_mataburro:
        type: string
      da_colchete:
        type: string
      da_atoleiro:
        type: string
      da_ponterustica:
        type: string
      turno_matutino:
        type: string
      turno_vespertino:
        type: string
      turno_noturno: 
        type: string
      shape:
        type: string
      hora_volta_inicio:
        type: string
      hora_volta_termino:
        type: string
      tempo:
        type: number
      tipo:
        type: integer
      id_firebase:
        type: string
      result: 
        type: boolean    
umarley commented 1 year ago

API Revisada e documentação atualizada.

Professor @marcosroriz houve mudança no retorno dos dados de veículos neste endpoint. Vai ser necessário alterar o fornt end. Antes estava recebendo um objeto e agora um array com vários objetos.