fossasia When to use
Use this skill when exposing new data or functionality via the DRF API using viewsets and serializers.
Steps
- Create or update a serializer in the appropriate location within
app/eventyay/api/. Prefer using explicit serializer fields covering direct model or nested relation mappings. - Create or update a viewset within
app/eventyay/api/. - Register the new viewset's router in the appropriate module router or
app/eventyay/api/urls.py.
Validation
- Verify that the serializer correctly maps exactly to the expected model or relations without unnecessary custom method wrappers.
- Assert the endpoint resolves effectively.
Gotchas
- Computed Data Overuse: Only use
SerializerMethodFieldfor genuinely computed or conditional data. Do NOT use it if a direct field assignment natively exists.