Add REST API - Githubissues

sveetch commented 3 years ago

This should be optional, enabled only when DRF is available. Add an extra requirement "api" to install DRF.

We aim for a read only API first. The write capacity may come in a future another issue.

This will need:

[x] Article Serializers;
[x] Category Serializers;
[x] Author Serializers;
[x] Article Viewsets;
[x] Category Viewsets;
[x] Author Viewsets
[x] Pagination enabled;
[x] Queryset have to respect the publication criterias and language;
[x] API URLs have to live in their own map apart so it can be mounted outside Lotus views path;
[x] API must be optional depending drf is installed or not (a new extra dependancies);
[x] Tests depending drf is installed or not, so we can check with/without it through a Tox environment;
[x] Look for possible resumed object payload in list and a more complete one from detail;

sveetch commented 2 years ago

At least to start a read only API although i can be a little risky to structure API code around read only, since write operations may sometime requires some changes.

sveetch commented 1 year ago

Also there is https://github.com/tfranzel/drf-spectacular which bring OpenAPI schema in more modern way that Swagger

sveetch commented 1 year ago

Detail payload may at least include related object listing like the views.

sveetch commented 1 year ago

It has been started in branch https://github.com/emencia/django-blog-lotus/tree/try_drf_addition, it's pretty basic, properly working and without test yet

sveetch commented 11 months ago

Finally after review for django-filter, currently i don't see any worth value to implement it for now. We will wait for a real use case in future after the first API release but removing it from todo list for now.

sveetch commented 9 months ago

Temporary branch for API beta is finished and delivered into v0.7.0 branch https://github.com/emencia/django-blog-lotus/tree/v0.7.0 to continue

emencia / django-blog-lotus

Add REST API #2