https://github.com/flacode/drf_practice
Using Django Rest Framework to build apis.
https://github.com/flacode/drf_practice
django-rest-framework python-3
Last synced: about 1 year ago
JSON representation
Using Django Rest Framework to build apis.
- Host: GitHub
- URL: https://github.com/flacode/drf_practice
- Owner: flacode
- Created: 2018-07-21T07:39:03.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-08T02:20:04.000Z (over 3 years ago)
- Last Synced: 2025-01-26T18:46:07.419Z (over 1 year ago)
- Topics: django-rest-framework, python-3
- Language: Python
- Size: 27.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BlogPost API
[](https://travis-ci.com/flacode/drf_practice)
[](https://coveralls.io/github/flacode/drf_practice?branch=ch-test-features)
[](https://codeclimate.com/github/flacode/drf_practice/maintainability)
> BlogPost API is a simple application that allows users to write, read and comment on blogs.
## Features
- Users can create accounts.
- Users can log in.
- Users can create, view, update and delete a blog post.
## Running the tests
Within the project's root directory, run
```coverage run --source=posts manage.py test && coverage report -m```
## Getting Started
### Prerequisites
1. Install requirements, run
```sh
pip install -r requirements.txt
```
2. Database configuration.
- Download and install postgres from [here](https://www.postgresql.org/download/)
- Create database in terminal
```sh
$ psql postgres;
$ CREATE DATABASE database_name;
```
- Store the database name under an environment variable called `DATABASE_URL` in the following format.
```sh
$ export DATABASE_URL='postgres://USER:PASSWORD@HOST:PORT/NAME'
```
3. Switch to the project's root directory and run migrations to create database tables.
```sh
$ python manage.py makemigrations
$ python manage.py migrate
```
4. Then run the application.
```sh
$ python manage.py runserver
```
## End points
### Endpoints to create a user account and login into the application
HTTP Method|End point | Public Access|Action
-----------|----------|--------------|------
POST | /entries/register/ | True | Create an account.
POST | /entries/login/ | True | Login a user.
GET | /entries/useradmin/ | False | Return list of registered users to a super user.
GET or DELETE | /entries/useradmin// | False | Allow super user to view user details and delete a user.
GET or PUT | /entries/user// | False | Allow a user to view their account details and update them.
## End points
### Endpoints for blog posts
HTTP Method|End point | Public Access|Action
-----------|----------|--------------|------
GET | /entries/ | True | Get all blog posts.
POST | /entries/ | False | Create a post.
GET | /entries// | False | Retrieve a certain post.
PUT or DELETE | /entries// | Update or delete a certain post by the author.