umarley / seteAPI

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

Módulo Veículos - GET - Obter a lista de veículos de um município #126

Closed glcalil-ufg closed 1 year ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

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

Resultado do experimento:

  • Retorno do HTTP está 200 (OK)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ ..., result: "true" }

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

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/veiculos/520140599

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 : “...” }



glcalil-ufg commented 2 years ago

@umarley

get:
      tags:
      - veiculos
      summary: Obter a lista de veículos de um município
      operationId: getVeiculo
      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
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/variosVeiculos'
        400:
          description: Parâmetros inválidos
        404:
          description: Veículos não encontrados
      security:
      - api_key: []

Modelo

 variosVeiculos: 
    properties: 
      data:
        type: array
        items:
          type: object
          properties:
            id_veiculo: 
              type: integer
            placa:
              type: string
            modelo:
              type: integer
            tipo:
              type: string
            capacidade:
              type: integer
            marca:
              type: string
            origem:
              type: string
            manutencao:
              type: string
      total:
        type: integer
      result:
        type: boolean
umarley commented 1 year ago

API revisada e documentação atualizada