Search code examples
djangodjango-rest-frameworkswaggeropenapidrf-yasg

Openapi 3 with Django drf

I am using Django with Django-Drf to write a restful BE.

I am also using drf-yasg to generate the swagger scheme for my service.

Unfortunately, drf-yasg does not yet support OpenApi3, and it doesn't look like it's going to in the foreseeable future.

Is there an alternative to drf-yasg, that does support Openapi 3 I can use together with Django-Drf?

Solution

  • Django DRF added OpenAPI3 support recently (3.10 i think), but it lacks a lot of functionality that drf-yasg has. The upcoming version (3.12) will add component support but still misses a lot of features like convenient customization options.

    We found ourselves in exactly the same situation. After some serious searching we came up empty and thus created a heavily modified fork of the DRF OpenAPI3 implementation, which is slowly approaching the functionality of drf-yasg.

    https://github.com/tfranzel/drf-spectacular

    Give it a try. It's still shaping up, but already covers a lot of cases. Feedback is welcome!