emencia / django-blog-lotus

A weblog application with Django.
https://django-blog-lotus.readthedocs.io/
MIT License
12 stars 1 forks source link

Check for usage of API browser beautifier #63

Open sveetch opened 1 year ago

sveetch commented 1 year ago

Is your feature request related to a problem? Please describe. Currently the API is browsable with included DRF API browser. It just works but it is not useful as something else like Swagger or Redoc.

Describe the solution you'd like drf-spectacular seems a good candidate to make OpenAPI schema and enable a more better browser like 'Swagger' or preferably 'Redoc'.

If it works well, use it in demonstration and make a note about it in documentation.

sveetch commented 11 months ago

Tried in branch https://github.com/emencia/django-blog-lotus/tree/add_django_spectacular (started from v0.8.1-pre.2), it works well but it needs some adjustments.

At least it fails to determine the right type for fields using SerializerMethodField, there is some warning about it in console logs to help on solving them.

Once finished, it would just need a bit of documentation and cleaning configuration in sandbox.

sveetch commented 1 month ago

Also, currently the sandbox include usage of drf-redesign that is a modest improvement on top of DRF API browser, it is far from spectacular improvement features but is a nice and light addition without to do anything except to install it.