Giter VIP home page Giter VIP logo

aueb_api's Introduction

Header image

AUEB Exams API

Providing a secure and easy way to query the Athens University of Economics and Business exam period information.

Domain model

Model entities

Model entity Description
Exams Entity representing a single examination date. Holds information about the exam's date, time and location.

Diagram

Domain model diagram

API endpoints

Exam model endpoints

  • /api/exams
  • /api/exams?date=<date> : date is a "DDMMYYYY" string
  • /api/exams?department=<department> : department is a string
  • /api/exams?professor=<professor> : professor is a string
  • /api/exams?course=<course> : course is a string
  • Plus all possible combinations of the above query parameters.

Services provided

The main goal of the project is to provide a functional and secure API for the university's exams table. Apart from that, the project aims to deliver more amenities that increase the ease of use and the overall quality.

API

As mentioned above, the API constitutes the central functionality of this effort and should thus be mentioned first. Using a series of endpoints, the API allows its users to query the different examination dates hosted by the university. A single token, which is delivered by the university to the end-users, is used to authenticate all incoming connections. Lastly, all logic was written using the Django REST framework.

Logger

In order to safeguard the API from malicious requests, a logger is used to document all traffic heading to the API. This is achieved by means of an additional middleware, named the RequestLogMiddleware, which monitors all incoming traffic.

Documentation

Note: Not yet implemented.

The proper way to utilize the API is detailed online, at a hosted webpage. Moreover, the present article which you've just read, constitutes an additional introduction to the API and its inner workings.

aueb_api's People

Contributors

konstantinosvasilopoulos avatar apipilikas avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.