Módulo Rotas - GET - Obter dados de uma rota específica

glcalil-ufg commented 2 years ago

Exemplo de requisição:
GET https://sete.transportesufg.eng.br/rotas/5201405/73170
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
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
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 2 years ago

@umarley

 get:
      tags:
      - rotas
      summary: Obter dados de uma rota específica
      operationId: getRotaId
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_municipio
        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/RotaGet'
        400:
          description: Parâmetros incorretos
        404:
          description: Rota não encontrada
      security:
      - api_key: []

Modelo

 RotaGet:
    type: object
    properties:
      codigo_cidade:
        type: integer
      id_rota:
        type: integer
      nome:
        type: string
      km:
        description: Tamanho da rota (em km)
        type: number
      hora_ida_inicio:
        description: Horário de inicio da Ida no formato hh:mm
        type: string
      hora_ida_termino:
        description: Horário de inicio da Volta no formato hh:mm
        type: string
      da_porteira:
        type: string
        description: Tem porteira? S = Sim N = Não
        enum:
        - S
        - N
      da_mataburro:
        type: string
        description: Tem mata-burro? S = Sim N = Não
        enum:
        - S
        - N
      da_colchete:
        type: string
        description: Tem colchete? S = Sim N = Não
        enum:
        - S
        - N
      da_atoleiro:
        type: string
        description: Tem atoleiro? S = Sim N = Não
        enum:
        - S
        - N
      da_ponterustica:
        type: string
        description: Tem ponte rústica? S = Sim N = Não
        enum:
        - S
        - N
      turno_matutino:
        type: string
        description: Funciona no turno da manhã? S = Sim N = Não
        enum:
        - S
        - N
      turno_vespertino:
        type: string
        description: Funciona no turno da tarde? S = Sim N = Não
        enum:
        - S
        - N
      turno_noturno:
        type: string
        description: Funciona no turno da noite? S = Sim N = Não
        enum:
        - S
        - N      
      hora_volta_inicio:
        description: Horário de inicio da Volta no formato hh:mm
        type: string
      hora_volta_termino:
        description:  Horário de término da Volta no formato hh:mm
        type: string
      tempo:
        description: Tempo da rota (em minutos)
        type: integer
      tipo:
        type: integer
        description: Tipo da rota 1. Rodoviária 2. Aquaviaria 3. Mista
        enum:
        - 1
        - 2
        - 3
      id_firebase:
        type: string
      result:
        type: boolean

umarley commented 1 year ago

API revisada e documentação atualizada

umarley / seteAPI

Módulo Rotas - GET - Obter dados de uma rota específica #130