umarley / seteAPI

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

Módulo Rotas - GET - Obter a lista de rotas de um município #129

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

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?

Exemplo de requisição:

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

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:
      - rotas
      summary: Obter a lista de rotas de um município
      operationId: getRota
      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
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/VariasRotas'
        400:
          description: Parâmetros incorretos
        404:
          description: Rota não encontrada
      security:
      - api_key: []

Modelo

 VariasRotas:
    properties:
      data:
        type: array
        items:
          type: object
          properties:
            codigo_cidade:
              type: integer
            id_rota:
              type: integer
            nome:
              type: string
            km:
              type: number
            tipo:
              type: integer
            turno_matutino:
              type: string
            turno_vespertino:
              type: string
            turno_noturno:
              type: string
            qtd_alunos:
              type: integer
            qtd_escolas:
              type: integer
            gps:
              type: string
      total:
        type: integer
      result:
        type: boolean
umarley commented 1 year ago

API revisada e documentação atualizada