hmtcelik / django-rest-elastic-example

Django REST + Elasticsearch Example in Containers

Django REST and Elasticsearch example

This is a simple example of how to use Django REST and Elasticsearch to search for with a keyword.

USAGE:

Prerequisites:

Don't forget to create a .env file with the following variables:

# .env
SECRET_KEY=your_secret_key

1. Get ready the containers:

docker-compose up --build

before continue, wait for everything ready (the elasticsearch wake up may tooks a few seconds)

2. Create the indexes and a user:

docker-compose exec api python manage.py create_indexes

you will also want to create a user to use the API:

docker-compose exec api python manage.py createsuperuser

3. Search in Elasticsearch via "management command" or endpoint:

docker-compose exec api python manage.py search_hostname <username> <password> <hostname>

or you can just use the endpoint:

curl --request POST \
  --url http://localhost:8000/api/search/ \
  --header 'Authorization: Octoxlabs <base64_token>' \
  --header 'Content-Type: application/json' \
  --data '{
        "query": "Hostname = octoxlabs*"
}'

(OPTIONAL) Run the tests:

You can directly run the tests after the containers are up (Step 1)

the others steps are not necessary to run the tests. They are already mocked.

docker-compose exec api python manage.py test