README.md

PoligonAPI

ArrowIT REST Server

Servidor REST en Django para Test de API para generar, listar, encontrar polígonos y verificar si un punto esta dentro del poligono

Contents

• Despliegue

  • Requerimientos
  • Django

• Usage

  • EndPoints Api

• Autors

• License

Despliegue

Luego de inicar la instancia Amazon Linux 2 en EC2 y conectarnos por medio de ssh

Requerimientos

• Paso 1 actualizar Amazon Linux 2 (EC2 Instance)

  yum update -y
  

• Paso 2 Instalar el repositorio Epel y descargar PIP

  sudo amazon-linux-extras install epel -y
  

• Paso 3 Instalar Django usando PIP

  Instalar PIP

  sudo yum install python3-pip -y
  

  Instalar Django

  pip3 install django
  

• Paso 4 Instalar Virtualenv y activar

  Instalar virtualenv

  sudo pip3 install virtualenv
  

  crear virtualenv

  virtualenv djangoenv
  

  activar virtualenv

  source ~/djangoenv/bin/activate
  

• Paso 5 Instalar Django dentro de virtualenv

  pip3 install – -upgrade Django
  

• Paso 7 Instalar sqlite3

  sudo yum install libsqlite3-dev
  

  fix sqlite3 error

  export LD_LIBRARY_PATH="/usr/local/lib/"
  

• Paso 8 Instalar DjangoRestframework

  pip3 install django djangorestframework django-cors-headers gunicorn
  

• Paso 9 Instalar shapely

  pip3 install shapely
  

• Paso 10 Instalar git

  sudo yum install git -y
  

• Paso 11 Clonar repositorio

  git clone https://github.com/Soichi-Tamashiro/PoligonAPI.git
  

Django

• Paso 1 Actualizar ALLOWED_HOST en settings.py agregar la IP publica de la instancia

  ALLOWED_HOSTS = [
    "18.219.166.96",
    "127.0.0.1",
  ]
  

• Paso 2 agregar una regla inbound para el puerto 8000

  

• Paso 3 Correr Django Restframework

  python manage.py runserver 0.0.0.0:8000
  

Usage

EndPoints Api

• Urls

  Función	Tipo	URLs
  Generar Polígono	POST	http://18.219.166.96:8000/polygon/create/
  Listar Polígonos	GET	http://18.219.166.96:8000/polygon/list/
  Encontrar Polígono	POST	http://18.219.166.96:8000/polygon/find/
  Verificar Punto	GET	http://18.219.166.96:8000/polygon/verify/

• Examples

  • Header and Token (back)

    Token para poder realizar los pedidos a la API

    Token

    3839b4431817b745f027644a104a69c66b949179
    

    POSTMAN Code

    

  • Generar Polígono (POST) (back)

    Agregar Polígono ingresando el número de puntos

    JSON Code

    {
      "puntos_n": 3
    }

    POSTMAN Code

    

  • Listar Polígonos (GET) (back)

    Listar todos los Polígonos

    JSON Code

    {
    }

    POSTMAN Code

    

  • Encontrar Polígono (POST) (back)

    Buscar Polígono con ID

    JSON Code

    {
        "id":2
    }

    POSTMAN Code

    

  • Verificar Punto (POST) (back)

    Verificar punto dentro del Polígono

    JSON Code

      {
        "id": 1,
        "x":0.0,
        "y":0.0
      }

    POSTMAN Code

    

Autors

• Soichi Tamashiro

License