Analise da API - Módulo ALUNO - Listar Alunos de um município

[glcalil-ufg]

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/alunos/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 vazios, verificar se é o correto com o Prof.  Marcos e o Umarley

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

API | Real -- | -- [  {    "nome": "string",    "loc_latitude": "string",    "loc_longitude": "string",    "loc_endereco": "string",    "loc_cep": "string"  
} ] | {    "data": [ 
       {    "codigo_cidade": 5201405,
            "id_aluno": 263189,
            "nome": "ALUNO TESTE2",
            "cpf": "",
            "loc_latitude": "",
            "loc_longitude": "",
            "nivel": 1,
            "turno": 1,
            "mec_tp_localizacao": 1,
            "escola": “Não Informada”,
            "rota": “Não Informada”,
            "_links": {                "_self": "https://sete.transportesufg.eng.br/alunos/5201405/263189"
            } 
       }, 
       . . .
      ], 
   “total”: 876,
    “result”: true
}

Exemplo de requisição:

GET https://sete.transportesufg.eng.br/alunos/520140599999

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

API | Real -- | -- Pet not found | {
    "result": false,
    "messages": "O municipio informado não existe!"
}

[marcosroriz]

Uma dúvida, na saída de erro, a resposta messages não deveria ser um vetor? Digo isso, pois isso tornaria a resposta padronizada em toda a API

[glcalil-ufg]

@umarley

get:
      tags:
      - alunos
      summary: Listar Alunos de um municipio
      description: Retorna uma lista com os alunos do município especificado
      produces:
      - application/json
      parameters:
      - name: codigo_cidade
        in: path
        description: Código do municipio 
        required: true
        type: integer
      responses:
        200:
          description: Operação realizada com sucesso
          schema:
            type: array
            items:
              $ref: '#/definitions/ListaAluno'
        400:
          description: Parametros incorretos
        404:
          description: Requisição não encontrada
      security:
      - api_key: []

Modelo

ListaAluno:
    type: object
    properties:
      data:
        type: array
        xml:
          wrapped: true
        items:
          $ref: '#/definitions/AlunoResumido'
      total:
        type: integer
      result:
        type: boolean
  AlunoResumido:
    type: object
    properties:
      codigo_cidade:
        type: integer
      id_aluno:
        type: integer
      nome:
        type: string
      cpf:
        type: string
      loc_latitude:
        type: string
      loc_longitude:
        type: string
      nivel:
        type: integer
      turno:
        type: integer
      mec_tp_localizacao: 
        type: integer
      escola:
        type: string
      rota:
        type: string

[umarley]

Documentação atualizada conforme funcionamento da API. Revisado a API para validação do retorno dos dados.