sibylassana95/GalsenAPi

GalsenApi est une API qui vous permet de manipuler facilement des données sur le Sénégal. Ce projet s'inspire du package Galsenify

Read in English

Installation 💻

Créez un environnement virtuel :

  python -m venv .venv

Activez l'environnement virtuel :

  source .venv/bin/activate

Installez les dépendances :

  pip install requirements.txt

Effectuez les migrations :

  python manage.py makemigrations
  python manage.py migrate

Créez un super utilisateur :

  python manage.py createsuperuser

Lancez le serveur :

  python manage.py runserver

Créez un fichier .env dans le projet Django pour stocker la clé secrète.

API Reference

Voici les différentes méthodes d'API disponibles :

Récupérer toutes les régions :

  GET /api/regions/

Récupérer une seule région :

  GET /api/regions/1/

Récupérer tous les départements :

  GET /api/departements

Récupérer un seul département :

  GET /api/departements/1/

Récupérer tous les villages :

  GET api/villages

Récupérer un seul département :

  GET /api/villages/1

Récupérer les informations sur le pays :

  GET /api/pays/

Utilisation

Pour récupérer toutes les régions : GET https://galsenapi.pythonanywhere.com/api/regions/

Exemple de résultat :

    [
    {
        "id": 1,
        "nom": "Dakar",
        "code": "DK",
        "population": 4042225,
        "superficie": 547,
        "departments": [
            "Dakar",
            "Pikine",
            "Guédiawaye",
            "Rufisque",
            "Keur Massar"
        ]
    },
    {
        "id": 2,
        "nom": "Diourbel",
        "code": "DB",
        "population": 1980821,
        "superficie": 4824,
        "departments": [
            "Diourbel",
            "Bambey",
            "Mbacké"
       	]
	}
]

Pour récupérer une seule région : https://galsenapi.pythonanywhere.com/api/regions/1/

Exemple de résultat :

    {
    "id": 1,
    "nom": "Dakar",
    "code": "DK",
    "population": 4042225,
    "superficie": 547,
    "departments": [
        "Dakar",
        "Pikine",
        "Guédiawaye",
        "Rufisque",
        "Keur Massar"
    ]
}

Captures d'écran

Voici quelques captures d'écran pour illustrer les résultats de l'API :

Récuperations des infos sur le pays

Récuperations de tout les Départements

Récuperations d'un seul departement

Récuperations de tout les Régions

Récuperations d'une seul région

Récuperations de tout les villages

Récuperations d'un seul village

👤 Author

Created by Lassana SIBY

🔗 Links

Merci à Daouda BA pour les donées.

Demo 🚀

Exemple d'utilisation de l'api

Views region et departement

def regions_view(request):
    query = request.GET.get('q')
    url = 'https://galsenapi.pythonanywhere.com/api/regions/'
    params = {'search': query} if query else {}
    response = requests.get(url, params=params)
    data = response.json()
    regions = data
    context = {'regions': regions, 'query': query}
    return render(request, 'demo/regions.html', context)


def departments_view(request):
    query = request.GET.get('q')
    url = 'https://galsenapi.pythonanywhere.com/api/departements/'
    params = {'search': query} if query else {}
    response = requests.get(url, params=params)
    data = response.json()
    departments = data
    context = {'departments': departments, 'query': query}
    return render(request, 'demo/departements.html', context)

def villages_view(request):
    query = request.GET.get('q')
    url = 'https://galsenapi.pythonanywhere.com/api/villages/'
    params = {'search': query} if query else {}
    response = requests.get(url, params=params)
    data = response.json()
    villages = data
    context = {'villages': villages, 'query': query}
    return render(request, 'demo/village.html', context)