Django DRF Project | API Documentation with Swagger UI | 18

In this tutorial, we learn how to start building documentation for our API, first creating a schema and then using Swagger UI to present details.

Udemy Course Link:

YouTube PlayList:

Developing applications can be a fun and effective way of learning a language and framework. In this course, at phase 1, we start building and testing an eCommerce inventory RESTful API with DRF (Django Rest Framework).

This course is primarily designed for anyone looking for a learning journey building applications with the Django Rest Framework, developing, testing and documenting a RESTful API.

This course presents our first iteration of this course and phase 1 of the development process. This course will evolve and extend over time as we iterate on the content to maximise learning opportunities.

As presented in phase 1 of the course, we initiate the project and start building and testing the core functionality of the RESTful API application. In Phase 1, we learn the fundamentals of the Python Django Rest Framework, design a database, implement testing throughout the application and work towards building our first endpoints while also automatically documenting our efforts. By the end of phase 1, you will have learnt how to start a new Django DRF project and create routers, serializers and viewsets to enable clients to interact with your API. Throughout the development process, we learn how to test our application using Pytest and document our endpoints in preparation for front-end development using SwaggerUI.

We intend to extend the content of the course to eventually include deeper relevant content to aid further your understanding of the development process and techniques, deployment, and other associated technologies. Due to the scale of our courses we hope to bring to you our approach to building courses is a phased, iterative approach. Having time to reflect, analyse and seek feedback is essential to ensure that we develop courses that will ultimately meet the highest expectations.

I hope you enjoy the course.

[gulnara]

I have started Swagger successfully with it. Thank you, very useful.

[GARUDA]

Hi.. great content.. how can we add authentication to access the api docs if I am using djoser for authentication of the project? Maybe some Login page for using username and password to redirect to api docs?

[phjehvn]

Is there a link to the project github?

[XeUs]

Hi Xander. You are doing a fantastic job with Django. Thank you for your effort. I'm still waiting for your django celery course. When can we expect it? Celery is a must for a django developer to get a job.

[dotnuel]

im getting this error:
assert False, f'ReadOnlyField target "{field}" must be property or model field'
AssertionError: ReadOnlyField target "ReadOnlyField()" must be property or model field, ive searched high and low for a solution its not anywhere

[mattm]

Please help me with this simple but impassable difficulty: How do I generate the schema publicly for APIs that even have permission enforced? Thanks.

[jatinsingh]

hey make a video on django deployment in vps plz ?.

[djangodeveloper]

Hi great tutorial like always, can we do some tasks in swagger ? like hide schema, and add custom help text for each api so user could know more about api, and we can show some common error status code so they know what kind of responses they are going to get using specific api.

if we can't modify it too much, which way is more appropriate to build custom api docs with swagger functionalities

[sebastianignaciorebolledoa]

Hi, I've done this process several time and today I did for a personal project but the API doesn't display the methods according to his own Model but instead show all the methods under the name of "api", what could I have done wrong?

[serhii-]

How do you decouple those sensitive endpoints from the rest of the project when pulling this code to prod? It would be great to NOT have all this in the same project, but rather keep API docs separate, otherwise it's a huge security breach when this API is not public and you need Swagger only for testing purposes, e.g. while doing initial manual QA. After manual QA this code should not be part of the project, therefore it's better for it not being the part of the project from the beginning.

[drmalex]

Why are we not using `django-rest-swagger`?

[sandeepmishra]

Teach how to make restapi on django .and how to apply on project in company