django-rest-framework-json-api | JSON : API support for Django REST framework | REST library

by django-json-api Python Version: v6.0.0 License: BSD-2-Clause

X-Ray Key Features Code Snippets Community Discussions(7)Vulnerabilities Install Support

kandi X-RAY | django-rest-framework-json-api Summary

django-rest-framework-json-api is a Python library typically used in Web Services, REST, Framework applications. django-rest-framework-json-api has no bugs, it has no vulnerabilities, it has build file available, it has a Permissive License and it has medium support. You can install using 'pip install django-rest-framework-json-api' or download it from GitHub, PyPI.

JSON:API support for Django REST framework

Support

Quality

Security

License

Reuse

Support

django-rest-framework-json-api has a medium active ecosystem.

It has 1084 star(s) with 295 fork(s). There are 40 watchers for this library.

It had no major release in the last 12 months.

There are 26 open issues and 351 have been closed. On average issues are closed in 328 days. There are 5 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of django-rest-framework-json-api is v6.0.0

Quality

django-rest-framework-json-api has no bugs reported.

Security

django-rest-framework-json-api has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

License

django-rest-framework-json-api is licensed under the BSD-2-Clause License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

django-rest-framework-json-api releases are available to install and integrate.

Deployable package is available in PyPI.

Build file is available. You can build the component from source.

Top functions reviewed by kandi - BETA

kandi has reviewed django-rest-framework-json-api and discovered the below as its top functions. This is intended to give you an instant insight into django-rest-framework-json-api implemented functionality, and help decide if they suit your requirements.

Get the queryset for the serializer
Returns a list of included resources
Return a list of included resources
Handles patch requests
Format a link segment
Instantiate a serializer instance
Return the field name for the related field
Returns the links to the object
Resolve a hyperlink to a hyperlink
Build a paginated response
Validate internal value
Default exception handler
Validate and return internal value
Returns a response object
Convert to internal value
Retrieve related models
Get fields from queryset
Gets the queryset
Return the choices for the field
Get package data
Returns a dict of links to this resource
Returns the filterset
Return a list of all installed python packages
Returns the polymorphic model for the given object type
Parse the given stream
Return a representation of the model

Get all kandi verified functions for this library.

django-rest-framework-json-api Key Features

No Key Features are available at this moment for django-rest-framework-json-api.

django-rest-framework-json-api Examples and Code Snippets

No Code Snippets are available at this moment for django-rest-framework-json-api.

Community Discussions

Trending Discussions on django-rest-framework-json-api

Django Swagger and JSON API render issues

Filter Django ResourceRelatedField's queryset

Django Rest Framework create multiple objects

Method "POST" not allowed with Django Rest Framework

Cannot create a polymorphic project instance in Django Rest framework JSON API example project

How to set resource name on an ad-hoc method of Viewset in Django Rest Framework JSON API?

Django REST Framework JSON API: Could not resolve URL for hyperlinked relationship when using ResourceRelatedField

QUESTION

Django Swagger and JSON API render issues

Asked 2020-Apr-22 at 16:21

Using django-rest-framework-json-api I am able to create API end points that work as described within the documentation. Attempted to provide API documentation using django-rest-swagger is not so easy.

1: Swagger uses media_type = 'application/json' which is not supported in the JSON API. To get around this I created a second render class (renderer_classes) that sub classes the JSON API JSONRenderer and forces the media type.

Now the end point supports application/json and application/vnd.api+json and swagger is happy to render in JSON API document structure. Aware that the generated curl requests have none a standard JSON API header.

2: Swagger has the same issue with the parser. While the work out from issue 1 does work there is a secondary challenge. Swagger renders a flat dictionary of field names which is not JSON API and ultimately is requested by DRF.

Is it possible to get swagger to parse in JSON API? At the moment Swagger is not working for PUT or POST.

...

ANSWER

Answered 2019-Apr-26 at 00:29

Answering my own question here so that others can gain value from what was learnt. We never found a solution to this issue and we did not have the time available to contribute to this project. In general the project also appears to be struggling, maybe due to people like us not contributing...

An alternative project drf-yasg has now emerged, which did not exist at the time of this original posting. drf-yasg was relatively easy to deploy and solved all of our issues so we have now migrated to this project instead.

So if you a looking for swagger api documentation for JSON API endpoints created within DRF, then I would suggest drf-yasg.

At the time of writing JSON API is not supported out of the box, but there is sample code to get it up and running relatively easily. With this change in place, all of the endpoints will be auto documented.

This Github Gist that contains the code from our app, hope that this helps you out until this feature is fully developed.

Source https://stackoverflow.com/questions/46157710

QUESTION

Filter Django ResourceRelatedField's queryset

Asked 2019-Nov-27 at 09:24

In our project we are using ResourceRelatedField for a foreign key field in one of our serializers to comply with JSON:API format. This is how it looks:

...

ANSWER

Answered 2019-Nov-27 at 09:24

Perhaps You can use a SerializerMethodResourceRelatedField? (not tested).

Source https://stackoverflow.com/questions/59066003

QUESTION

Django Rest Framework create multiple objects

Asked 2019-Jan-07 at 21:56

This is what I have so far.

My serializer:

...

ANSWER

Answered 2019-Jan-07 at 21:56

Ok, I am actually surprised that the creation of a single object instance works, since the data doesn't seem to be in the correct format. When the many argument is used, the serializer expects a list but what you send is a json object.

This is what the JSON should like:

Source https://stackoverflow.com/questions/54059415

QUESTION

Method "POST" not allowed with Django Rest Framework

Asked 2018-Sep-11 at 01:38

I'm trying to create a JSON API compliant rest service using Django Rest Framework JSON API: https://django-rest-framework-json-api.readthedocs.io/en/stable/index.html

I think I'm stuck at the Django Rest Framework level, but I am not certain.

I think the GET request is working, but the POST is not because I get this response:

...

ANSWER

Answered 2018-Sep-07 at 03:21

Add some API prefix to your url include statement as,

Source https://stackoverflow.com/questions/52211142

QUESTION

Cannot create a polymorphic project instance in Django Rest framework JSON API example project

Asked 2018-May-08 at 21:38

I am trying to understand how polymorphic resources work in django-rest-framework-json-api and I get the following error both on my own project and the example project provided by django-rest-framework-json-api. My models are created using django-polymorphic. The example project I am trying to run is https://github.com/django-json-api/django-rest-framework-json-api/tree/master/example.

Endpoint : localhost:8000/projects

...

ANSWER

Answered 2018-May-08 at 21:38

I was initially trying to create instances in the browser which threw the error above and didn't let me choose child types. I tested this on Postman and specified the type and it worked. I had the impression that I could even create an instance of Project as well (Parent instance itself, not a child instance) but as error message clearly says, I can't.

Source https://stackoverflow.com/questions/50190892

QUESTION

How to set resource name on an ad-hoc method of Viewset in Django Rest Framework JSON API?

Asked 2017-Feb-14 at 07:37

I am using Django 1.10 with DRF 3.5 and Django Rest Framework JSON API 2.1.1. I have a Viewset that follows the normal pattern of a ModelViewset, but I need to add an ad-hoc as follows:

...

ANSWER

Answered 2017-Feb-14 at 07:37

The ViewSet is the controller of the resource. It doesn't make sense to set a method on a ViewSet and associate it with another resource.

Either write a function with decorator to make an API entry point or get a new ViewSet for it.

Source https://stackoverflow.com/questions/42220148

QUESTION

Django REST Framework JSON API: Could not resolve URL for hyperlinked relationship when using ResourceRelatedField

Asked 2017-Feb-13 at 20:55

I am writing an HTTP API that uses django + django REST framework + django REST framework JSON API. When I tried to do PATCH request I received this error,

Incorrect type. Expected URL string, received OrderedDict

when updating relationship. Looking through issues I understood I need to use ResourceRelatedField.

I'm trying to follow documentation here Related fields. Below is how my code looks like.

urls.py

...

ANSWER

Answered 2017-Feb-13 at 20:55

Renaming event_pk to pk in url argument solved the problem.

Source https://stackoverflow.com/questions/42138454

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install django-rest-framework-json-api

You can install using 'pip install django-rest-framework-json-api' or download it from GitHub, PyPI.
You can use django-rest-framework-json-api like any standard Python library. You will need to make sure that you have a development environment consisting of a Python distribution including header files, a compiler, pip, and git installed. Make sure that your pip, setuptools, and wheel are up to date. When using pip it is generally recommended to install packages in a virtual environment to avoid changes to the system.

Support

For any new features, suggestions and bugs create an issue on GitHub. If you have any questions check and ask questions on community page Stack Overflow .

Find more information at: