matejhocevar / djangorest

Simple django rest application based on django REST framework for demostration and learning purposes

django REST

Simple django rest application for demostration and learning purposes built with django rest framework

Prerequisites

Libraries

virtualenv
pip
django

Database

This project use internal SQLite database, so there is no need for database setup. If you want to change database you can do it in settings.py file.

Installation

Clone project

git clone https://github.com/matoxxx/djangoREST.git

Navigate to:

cd djangoREST

Create virtual enviroment

virtualenv env  

Activate virtual enviroment

on Windows:

cd env/Scripts
activate

on Unix:

source env/bin/activate

Install dependencies:

pip install -r requirements.txt

Migrate database:

python manage.py migrate

Create root user:

python manage.py createsuperuser

Usage:

Run server:

python manage.py runsever <ip:port>			# example: python manage.py runserver 127.0.0.1:8000

REST API:

Django REST framework offers their own REST api via browser: http://127.0.0.1:8000/snippets/

Requests with httpie library:

http http://127.0.0.1:8000/snippets/
http http://127.0.0.1:8000/users/ Accept:text/html
http http://127.0.0.1:8000/users/ Accept:application/xml
http http://127.0.0.1:8000/snippets.json
http http://127.0.0.1:8000/users.api

Using HTTP methods:

http <GET | POST | PUT | DELETE | OPTIONS | HEAD> http://127.0.0.1:8000/snippets/

Post using form data:

http --form POST http://127.0.0.1:8000/snippets/ code="print 123"

Post using JSON:

http --json POST http://127.0.0.1:8000/snippets/ code="print 456"

Using authentication:

http -a matej:password POST http://127.0.0.1:8000/snippets/ code="print 789"

Author

Matej Hocevar @matoxxx