SMSWithoutBorders OpenAPI
SMSWithoutBorders OpenAPI intègre un système de file d'attente simple avec RabbitMQ, qui permet aux développeurs de gérer les messages SMS sortants à partir de leurs clients Gateway.
:::conseil Ce que vous apprendrez
- Comment configurer et utiliser OpenAPI
La version la plus récente de ce guide se trouve dans le github reposistory
Le frontend s'intègre à ces services. Il se peut que vous deviez les configurer en fonction de la section sur laquelle vous travaillez.
:::
Table des matières
- Exigences
- Dépendances
- Installation
- [Mise en place](#Mise en place)
Exigences
Dépendances
Ce projet contient des sous-modules. Pour cloner tous les sous-modules, utilisez
git submodule update --init --recursive --remote
Mise en place RabbitMQ Server
- Déplacer dans le répertoire RabbitMQ dans le repo
cd RabbitMQ
Sur Ubuntu libmysqlclient-dev est nécessaire.
sudo apt install python3-dev libmysqlclient-dev
Installation
Créer un environnement virtuel (venv).
python3 -m venv venv
Se déplacer dans l'espace de travail des environnements virtuels.
. venv/bin/activate
Installer tous les paquets python.
python -m pip install -r requirements.txt
Mise en place
Tous les fichiers de configuration se trouvent dans le répertoire**config** répertoire.
Development configurations
default.ini est le fichier de configuration.
Pour configurer l'API, copiez les fichiers modèles "example.default.ini" et renommez-les en "default.ini".
cp config/example.default.ini config/default.ini
Configurations d'accès
setup.ini est le fichier d'accès. Pour configurer l'accès, copiez les fichiers modèles "example.setup.ini" et renommez-les en "setup.ini".
cp example.setup.ini setup.ini
Comment l'utiliser
Démarrer l'API
python3 server.py
API SandBox
<host>:<PORT>/<VERSION>/api-docs/