https://github.com/p0ne/sentryo-api

Test technique pour sentryo
https://github.com/p0ne/sentryo-api

Last synced: about 2 months ago
JSON representation

Test technique pour sentryo

• Host: GitHub
• URL: https://github.com/p0ne/sentryo-api
• Owner: P0NE
• Created: 2019-08-12T15:09:32.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-25T02:25:36.000Z (over 2 years ago)
• Last Synced: 2023-12-17T08:10:26.809Z (about 1 year ago)
• Language: Python
• Size: 36.1 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Installation

  - Cloner le repo `$ git clone https://github.com/P0NE/sentryo-api.git`

  - Se mettre dans le répertoire `$ cd /sentryo-api`

  - Creér un environnement virtuel `$ python -m venv venv`

  - Activer l'environnement virtuel `source venv/bin/activate`

  - Installer les dépendances `$ pip install requirements.txt`

  - Créer un fichier `.env` avec :

      ```

      FLASK_ENV=development

      DATABASE_URL=sqlite:///../data/swapi.dat

      JWT_SECRET_KEY=bonjoursentryo

      ```

  - Démarrer l'app avec `python run.py`

## Utilisation

  - Pour tester les APIs, on peut utiliser `POSTMAN`

  - Récupérer tout les peoples : GET

  ```

  http://127.0.0.1:5000/api/peoples/

  ```

  - Récupérer un people : GET

  ```

  http://127.0.0.1:5000/api/peoples/

  ```

  - Update un people : PATCH

  ```

  http://127.0.0.1:5000/api/peoples/

    {

        "name": "Michel"

    }

  ```

  - Delete un people : DELETE

  ```

  http://127.0.0.1:5000/api/peoples/

  ```

  - Create un people: POST

  ```

  http://127.0.0.1:5000/api/peoples/

    {

	"name": "mm",

	"birth_year": "64BBY",

    "eye_color": "blue",

    "gender": "male",

    "hair_color": "auburn, grey",

    "height": "180",

    "homeworld": "21",

    "mass": "unknown",

    "skin_color": "fair"

   }

  ```

## Explication

  - J'ai d'abord tenter le test technique en GO mais je me suis confronter à un problème en voulant utiliser GORM pour le mapping relationnel, notamment avec ce bout de code : 

    ```

    var peoples []People

	if err = db.Table("People").Joins("LEFT JOIN people_vehicles on people_vehicles.people=people.id").

		Joins("LEFT JOIN vehicles on vehicles.id=people_vehicles.vehicles").Preload("Vehicles").Find(&peoples).Error; err != nil {

		log.Fatal(err)

	}

    ```

    J'espère pouvoir en discuter avec vous.

    - J'ai donc décidé de faire le projet dans un language que je maitrise mieux à l'heure actuelle: Python.

    Pour les APIs j'ai fait le choix d'utiliser `Flask-rest-plus` que je trouve très pratique et facile à utiliser pour ce genre de projet et pour le framework ORM j'ai choisi `SQLAlchemy`

    Je n'ai pas fini tout ce que je souhaitais faire à cause du temps. J'ai listé dans la partie d'après tout ce que je peux rajouter.

## TODOS

  - Ajouter la définition swagger pour les différents Endpoint.

  - Ajouter les TU pour tester les modèles et les views (request, response, status code...)

  - Ajouter une authentification par JWT

  - Finir la python doc et ajouter des commentaires

  - Ajouter la possibilité de lier un people avec un vehicle et un starship.

  - Modifier la base de données, notamment les types de certains champs et certaines colonnes de la table people (vehicles ?, Starships ?)