umarley / seteAPI

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

Módulo Alunos - POST - Incluir uma rota para o aluno #168

Open glcalil-ufg opened 2 years ago

glcalil-ufg commented 2 years ago

Exemplo de requisição:

POST https://sete.transportesufg.eng.br/aluno/5201405/263189/rota

Path:

codigo_cidade: 5201405

id_aluno: 5201405

Body:


Resultado do experimento:

  • Retorno do HTTP está 201 (CREATED)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ result: "true", messages: {“id”: <>} }


Exemplo de requisição:

POST https://sete.transportesufg.eng.br/aluno/5201405/263189/rota

1 - Rota errada;

2 - Aluno já vinculado a uma rota;

3 - Campo rota vazio; 

4 - Codigo cidade errado;

Resultado do experimento:

  • Retorno do HTTP está 400 (BAD REQUEST)

  • O resultado está diferente do esperado na API

  • Está usando o seguinte formato 

{ result: "false", messages : “...” }






glcalil-ufg commented 1 year ago

@umarley

post:
      tags:
      - alunos
      summary: Incluir uma rota para o aluno
      operationId: associarRota
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: codigo_cidade
        type: integer
        description: Código da cidade do aluno a ser atualizado
        required: true
      - in: path
        name: id_aluno
        type: integer
        description: ID do aluno a ser atualizado
        required: true
      - in: body
        name: body
        description: JSON contendo o id_rota que será associada
        required: true
        schema:
          $ref: '#/definitions/associarRota'
      responses:
        201:
          description: Operação realizada com sucesso
          schema:
            $ref: '#/definitions/CreateResponse'
        400:
          description: Parâmetros invalidos
        404:
          description: Não encontrado
      security:
      - api_key: []

Modelo Body

associarRota:
    required:
      - id_rota
    type: object
    properties:
      id_rota:
        type: integer