Django Rest Framework Series - API Schema and Documentation Generation - Part-5

Hello, we are back again for the forth tutorial in this Django Rest Framework Series. In the following series of tutorials we will go through the Django Rest Framework and in addition build a React application to consume our Django Rest API. In this tutorial we introduce schemas and generating documentation for our project, handy for referencing our API, the endpoints that are available when developing our front-ends

🎉More from this Django Rest Framework Series:

00:00 Introduction / Context
03:02 Generating the schema
08:47 API documentation options
10:23 Install and configure an API documentation interface

Code Repository:

👍SUBSCRIBE to get more free tutorials, courses and code snippets!

👍👍Follow us on Facebook

👍👍👍Follow use on Twitter:

[egehurturk]

You are the best youtube channel when it comes to Django. Huuuge thanks, man. Keep it up!

[TheBodybuildingG]

Now this is a topic I never saw approached. Keep it up!

[mariamzayed]

it's amazing getting this huge benefitable knowledge form one series! Thank You!

[Acel-]

Thank you very much! Been trying to generate a documentaion for the project I'm working on for days but kept running into issues. Thanks again for this video, very easy to follow with no hassle

[quienestumadre]

This is the exact thig I was looking for, Thanks!

[jeraldjoshuaechavia]

The best django channel for me!!!! Can I give this a double thumbs up instead? Congrats for this, again, very informative tutorial.

[santhoshreddy]

Thank you, you made it look very simple, I couldn't understand it properly when I was going through doucmentation.

[qvcxhwd]

Amazing !!!! , Thanks to this, it will be very useful for collaboration with frontend

[prateeksarangi]

Thanks !! Again you are awesome !! Looking forward to see future content !

[davistodt]

Can someone explain to me what is being offered here by using swagger docs instead of the "built in" api docs you're getting for free from DRF? I'm clearly missing something and am new to DRF. Thanks in advance

[nikhilbhardwaj]

But how can we integrate jwt in it (add path('api/docs/', include_docs_urls(title="Rest Framework Api",
authentication_classes=[],
permission_classes=[]
))
Thank you so much :)

[rafalpantoja]

Good evening, is it possible to customize this document that Django generates automatically, if so can you help me?

[Chowdahhh]

Hi! I've generated my schema following the tutorial but when viewing it like you do at 8:30, I don't see the properties the api call requires, just a $ref line, like this:

/api/token/:
post:
operationId: createTokenObtainPair
description: 'Takes a set of user credentials and returns an access and refresh
JSON web

token pair to prove the authentication of those credentials.'
parameters: []
requestBody:
content:
application/json:
schema:
$ref:


Any idea why this could be?

[greendramost]

Thank you for the video. Is there a way to generate similar documentation if I'm using Django, not DRF?

[cristiancamilosanchezardil]

Is there a way to make it a json raw data and not fill a form?

[siddharthshukla]

please consider doing a project based on django-channels where views, models, etc are being used.
or maybe somehow use django-channels in this project.

[amanjain]

I got an error saying view() requires a positional argument. Dont know why!

[Empusas]

you explained the swagger UI features, but then did not use it?

[ABHISHEKKUMAR-pcvh]

I got this error can you please help me:

"Could not import for API setting 'DEFAULT_SCHEMA_CLASS'. ModuleNotFoundError: No module named

[AlwataniaAgence]

Hi, I’m so confused, I have an e-commerce web site, only Django, html, css and is, for dB I used MySQL. I want to build an android app for the existing web project. How can I do? I searched for a lot and didn’t found any information about it.