umarley / seteAPI

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

Módulo garagens - GET - Obter dados de um veículo específico #108

Closed nataliasou closed 1 year ago

nataliasou commented 2 years ago

image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/garagens/5201405/136 Resultado: • Retorno do HTTP é 200 - Ok • O resultado não está documentado na API • Está usando o seguinte formato {..., result: "true"} • Possui link e algumas variáveis possuem o retorno “string”, verificar se isso é o correto com o prof. image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/garagens/5201405/0 Resultado: • Retorno do HTTP é 404 – Not found • O resultado não está documentado na API • Está usando o seguinte formato {..., result: "false"} • Possui link, verificar se isso é o correto com o prof. image

Exemplo de requisição: GET https://sete.transportesufg.eng.br/garagens/0/136 Resultado: • Retorno do HTTP é 400 – Bad request • O resultado não está documentado na API • Está usando o seguinte formato {result: "false", “messages”: “string”} • Possui link, verificar se isso é o correto com o prof. image

nataliasou commented 1 year ago

@umarley

get:
      tags:
      - garagens
      summary: Obter dados de uma garagem específica
      operationId: getGaragemId
      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_garagem
        description: ID da garagem que se deseja consultar 
        required: true
        type: integer
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
              $ref: '#/definitions/GaragemEspecifica'
        400:
          description: Parâmetros incorretos
        404:
          description: Recurso não encontrado.
      security:
      - api_key: []

Models:

GaragemEspecifica:
    type: object
    properties:
      codigo_cidade:
        type: integer
      id_garagem:
        type: integer
      loc_latitude:
        type: string
      loc_longitude:
        type: string
      loc_endereco:
        type: string
      loc_cep:
        type: string
      id_firebase:
        type: integer
      nome:
        type: string
      result:
        type: boolean
umarley commented 1 year ago

API revisada e Documentação atualizada