A continuación se muestra una pequeña descripción de los endpoints existentes en la API. La url base de la API es miw.danimeana.es/safepoint.
| HTTP Method | Ruta | Descripción |
|---|---|---|
| GET | /categories | Listado de todas categorias de incidencias. |
| GET | /categories/id/reports | Listado con todas las incidencias de la categoría cuyo identificador es id. |
| GET | /reports | Listado con todas las incidencias de todas las categorias. |
| POST | /reports | Crea una incidencia nueva. Los parametros necesarios son: lat, lng, description y category_id. Además es necesario estár logeado en el sistema. |
| GET | /reports/id | Detalles de la incidencia cuyo identificador es id. |
| DELETE | /reports/id | Elimina la incidencia cuyo identificador es id. |
La aplicación ha sido testeada baja Python3. A continuación se detallan los pasos para su instalación en Ubuntu y Mac OS X y ejecución.
Instalar las herramientas de Python3:
- Ubuntu:
sudo apt-get update
sudo apt-get -y install python3 python3-pip
sudo pip3 install virtualenv- Mac OS X (requiere brew):
sudo brew update
brew install python3
sudo pip3 install virtualenvClonar el repositorio y acceder a él:
git clone https://github.com/davidmogar/SafePoint
cd SafePointCrear el entorno virtual:
virtualenv venvActivamos el entorno virtual:
. venv/bin/activateInstalar las dependencias:
pip3 install -r requirementsDesactivamos el entorno virtual:
deactivateA continuación se detallan los pasos a seguir para ejecutar el servidor web.
Activamos el entorno virtual:
. venv/bin/activateEjecutar el servidor:
python3 run.pyLa activación del entorno virtual será necesaria cada vez que se quiera ejecutar el servidor. Para desactivar el entorno virtual puede utilizarse el comando:
deactivate