OC - PROJECT N°10 - RESTful API Using Django Rest Framework

SoftDesk is an API for reporting and tracking technical issues.

By Douglas Lopes

Project Overview

Endpoints Summary

Access Specification

Example

PUT : /projects/1/

• Author of the project 1 can update it
• Contributor of the project 1 can read only detail
• Other user of the API (not author or contributor) of project 1 can't access detail information of project 1

(back to top)

Built With

• Python
• Django Rest Framework
• JSON Web Token

(back to top)

Getting Started

Installation & Running the script

1. Clone the repo

   git clone https://github.com/Jliezed/oc_project_10_softdesk.git

Create and activate a virtual environment

2. Go to your project directory

   cd oc_project_10_litreview

3. Install venv library (if not yet in your computer)

   pip install venv

4. Create a virtual environment

   python -m venv env

5. Activate the virtual environment

   source env/bin/activate

Install packages

6. Install the packages using requirements.txt

   pip install -r requirements.txt

Set environment variables

7. Create a copy of the file ".env.default" and rename it ".env"
8. Set value to the .env file:

   1. Define a secret key

   2. Debug to True for local development or False for production

   3. Allowed host equal to 127.0.0.1 for local environment

      SECRET_KEY='YOUR SECRET KEY'
      DEBUG=True
      ALLOWED_HOSTS=['127.0.0.1']

Run the server

python manage.py runserver

9. Log to the API: http://127.0.0.1:8000/api/auth/login/

   User: toto
   Password: secret

10. Or create a superuser

python manage.py createsuperuser

Access the different endpoints

• http://127.0.0.1:8000/api/projects/
• http://127.0.0.1:8000/api/projects/1
• http://127.0.0.1:8000/api/projects/1/users/
• http://127.0.0.1:8000/api/projects/1/issues/
• http://127.0.0.1:8000/api/projects/1/issues/1
• http://127.0.0.1:8000/api/projects/1/issues/1/comments/
• http://127.0.0.1:8000/api/projects/1/issues/1/comments/1

---

(back to top)

API Documentation

• Postman: https://documenter.getpostman.com/view/21205949/2s8YCboFSd
• Swagger: http://127.0.0.1:8000/api/docs/#/

(back to top)