Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ushurbakiyevdavlat/drf-blog-app

Blog api on DRF
https://github.com/ushurbakiyevdavlat/drf-blog-app

allauth corsheaders django-rest-framework heroku-deployment postgresql python redoc sqlite swagger-ui viewsets whitenoise

Last synced: 29 days ago
JSON representation

Blog api on DRF

Awesome Lists containing this project

README 

        
# BlogApi

## Blog api on DRF



We have deliberately repeated several steps from our earlier examples so the pattern

of creating a new Django project and then its API should start to feel more familiar. The models

are are pure traditional Django but otherwise the URLs, views, and serializers all come from DRF.

We added a detail endpoint to our API and started to explore the power of serializers.

The Blog API is completely functional for local use at this point however there is a big problem:

anyone can update or delete an existing blog post! In other words, we do not have any

permissions in place. In the next chapter we will learn how to apply permissions to protect our

API.



Setting proper permissions is a very important part of any API. As a general strategy, it is a good

idea to set a strict project-level permissions policy such that only authenticated users can view

the API. Then make view-level or custom permissions more accessible as needed on specific API

endpoints.



User authentication is one of the hardest areas to grasp when first working with web APIs.

Without the benefit of a monolithic structure, we as developers have to deeply understand and

configure our HTTP request/response cycles appropriately.

Django REST Framework comes with a lot of built-in support for this process, including

built-in TokenAuthentication. However developers must configure additional areas like user

registration and dedicated urls/views themselves. As a result, a popular, powerful, and secure

approach is to rely on the third-party packages dj-rest-auth and django-allauth to minimize

the amount of code we have to write from scratch.



Viewsets and routers are a powerful abstraction that reduce the amount of code we as developers

must write. However this conciseness comes at the cost of an initial learning curve. It will feel

strange the first few times you use viewsets and routers instead of views and URL patterns.

Chapter 9: Viewsets and Routers 167

Ultimately the decision of when to add viewsets and routers to your project is subjective. A good

rule of thumb is to start with views and URLs. As your API grows in complexity if you find yourself

repeating the same endpoint patterns over and over again, then look to viewsets and routers.

Until then, keep things simple.



Adding a schema and documentation is a vital part of any API. It is typically the first thing a fellow

developer looks at, either within a team or on an open-source projects. Thanks to the automated

Chapter 10: Schemas and Documentation 176

tools covered in this chapter, ensuring your API has accurate, up-to-date documentation only

requires a small amount of configuration. The last step is to deploy the Blog API properly which

we’ll cover in the next chapter.