Oscar API Settings¶
Main settings¶
OSCARAPI_BLOCK_ADMIN_API_ACCESS
¶
Default: True
Useful in production websites wehere you want to make sure that admin users can’t access the API (they can read/write anything which is exposed by the API).
Serializer settings¶
Most of the model serializers in Oscar API have a default set of fields to use in the REST API. If you customized the Oscar models you can reflect this customization by adding settings for this serializer.
For example, the RecommendedProduct
serializer is defined as following:
class RecommmendedProductSerializer(OscarModelSerializer):
url = serializers.HyperlinkedIdentityField(view_name='product-detail')
class Meta:
model = Product
fields = overridable(
'OSCARAPI_RECOMMENDED_PRODUCT_FIELDS',
default=('url',)
)
When you add the following section to your settings.py
you will add the ‘title’ field as well:
OSCARAPI_RECOMMENDED_PRODUCT_FIELDS = ('url', 'title')
The following serializers have customizable field settings:
Basket serializers¶
-
class
oscarapi.serializers.basket.
BasketSerializer
(instance=None, data=<class rest_framework.fields.empty>, **kwargs)[source]¶
Checkout serializers¶
-
class
oscarapi.serializers.checkout.
OrderSerializer
(*args, **kwargs)[source]¶ The order serializer tries to have the same kind of structure as the basket. That way the same kind of logic can be used to display the order as the basket in the checkout process.