drf-yasg VS drf-spectacular

I believe drf-yasg what you need. You can create a schema manually and define request and response types for your small API.

Check this out: https://drf-yasg.readthedocs.io/en/stable/

There's also the caveat of having different API documentation for both the frontend solution and the API-only solution, since I don't want to expose the frontend-specific endpoints to the API-only endpoints, but I think that might just take some time playing around with swagger: https://drf-yasg.readthedocs.io/en/stable/

Swagger and OpenAPI capabilities using drf-yasg, where you can only see endpoints and Swagger docs if you have a valid Token

The major apps are news and accounts. While the former handles almost all the physical functionalities of the system, the latter only does user stuff. The api app exposes the data for consumption. It is documented using drf-yasg, a Swagger generation tool implemented without using the schema generation provided by Django Rest Framework. The api has a token-based authentication which requires that all POST requests must provide a token to be accepted, otherwise a not too interesting response:

Our RESTful API was actually the easiest to document, because we were able to rely on third-party libraries from the start. It was a Python Django and Django REST Framework project that leveraged the drf-yasg OpenAPI generator library to create OpenAPI and Swagger compatible documentation.

This post will go through how to document your DRF APIs using https://github.com/axnsan12/drf-yasg/ package.

Hi, while that is the case, same can be done with drf using drf-spectacular

I would suggest drf-spectacular instead because https://github.com/axnsan12/drf-yasg#openapi-30-note

Here is your answer: drf_spectacular

If you roll your own thing, you will probably just end up re-implementing a crappy version of something that already exists. Plus, you'll miss out on really nice utilities like this one.

Generate OpenAPI3 schema for error responses using drf-spectacular: No API is complete without proper documentation. This is work in progress (PR1 and PR2). Most of it is done, but I still need to add tests and documentation. Hopefully, that will be done over the next few week(end)s. But, if you want to get a glimpse on the expected result, here’s a screenshot of a test endpoint using swagger UI.

drf-yasg - generates schema for django application - GitHub - axnsan12/drf-yasg