umarley / seteAPI

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

Módulo Motoristas- GET - Obter lista de motoristas de um município #120

Closed glcalil-ufg closed 1 year ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/motoristas/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>, result: "true" }

  • Há vários campos NULL, verificar se é o correto com o Prof.  Marcos e o Umarley

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

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/motoristas/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:
      - motoristas
      summary: Obter a lista de motoristas de um município
      operationId: getMotoristas
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        description: Código do municipio que o motorista pertence
        required: true
        type: integer
      responses:
        200:
          description: Operação Realizada com Sucesso
          schema:
            $ref: '#/definitions/Motoristas'
        400:
          description: Parametros incorretos
        404:
          description: Motorista não encontrado
      security:
      - api_key: []

Modelo

Motoristas:
    type: object
    properties:
      data:
        type: array
        xml:
          wrapped: true
        items:
          $ref: '#/definitions/MotoristaResumido'
      total:
        type: integer
      result:
        type: boolean
  MotoristaResumido:
    type: object
    properties:
      codigo_cidade:
        type: integer
      cpf:
        type: integer
      nome: 
        type: string
      telefone:
        type: string
      cnh:
        type: string
      data_validade_cnh:
        type: string
      turno_manha:
        type: string
        description: Trabalha no turno da manhã? S = Sim N = Não
        enum:
        - S
        - N
      turno_tarde:
        type: string
        description: Trabalha no turno da tarde? S = Sim N = Não
        enum:
        - S
        - N
      turno_noite:
        type: string
        description: Trabalha no turno da noite? S = Sim N = Não
        enum:
        - S
        - N
umarley commented 1 year ago

API revisada e documentação atualizada.