Api d'informations sur les régions, préfectures, sous-préfectures, communes et quartiers de la Guinée
# 🇬🇳 API Guinée Geo
> Une API open-source fournissant des données géographiques structurées sur les subdivisions administratives de la Guinée.
---
## 🧭 Table des matières
- Présentation
- Technologies
- Hiérarchie administrative
- Base URL
- Installation locale
- Endpoints principaux
- Documentation Swagger
- Contribuer
- Licence
---
## 📌 Présentation
L'**API Guinée Geo** est une API RESTful qui permet d'accéder à la hiérarchie administrative de la Guinée :
- Régions
- Préfectures
- Sous-préfectures
- Communes
- Quartiers
Utile pour les développeurs, chercheurs, ONG, gouvernements locaux ou toute personne ayant besoin de données géographiques fiables sur la Guinée.
---
## 🛠️ Technologies
- Node.js + Express.js (Backend REST API)
- MongoDB + Mongoose (Base de données)
- Swagger (Documentation API)
- Vercel (Déploiement serverless)
---
## 🗺️ Hiérarchie administrative
```mermaid
graph TD
Pays --> Region
Region --> Prefecture
Prefecture --> SousPrefecture
Region --> Commune
Commune --> Quartier
```
---
## 🌐 Base URL
```
api-guinea-geo.vercel.app
```
---
## 💻 Installation locale
```bash
git clone
github.com
cd api-guinea-geo
npm install
```
Créer un fichier `.env` avec :
```env
MONGO_URI=
```
Lancer le serveur :
```bash
npm run dev
```
---
## 🔗 Endpoints principaux
### ✅ Régions
- `GET /regions` — liste toutes les régions
- `GET /regions/search?name=Labé` — recherche par nom
- `GET /regions/:name/prefectures` — préfectures d'une région
### ✅ Préfectures
- `GET /prefectures` — liste toutes les préfectures
- `GET /prefectures/search?name=Labé` — recherche par nom
- `GET /prefectures/stats` — statistiques globales ou par région (`?region=Faranah`)
### ✅ Sous-Préfectures
- `GET /sous-prefectures` — liste complète
- `GET /sous-prefectures/search?name=Koulé`
### ✅ Communes
- `GET /communes`
- ` …