Django
Swagger - SerializerMethodField의 return type hint
r잡초처럼
2023. 7. 4. 23:20
django rest framework에서 SerializerMethodField 필드의 return 타입이 원시형이 아닌 Serializer의 형태일 때 어떻게 API Docs에서 보여줄 것인가에 대한 고민이 있었다. drf-yasg를 검색해 본 결과 아래의 어노테이션을 선언하면 object 형태의 Serializer 도 보여줄 수 있었다
@swagger_serializer_method(serializer_or_field=FooSerializer)
def get_foo_list(self, obj)
return FooSerializer(obj.instance).data
참고: https://drf-yasg.readthedocs.io/en/stable/custom_spec.html#support-for-serializermethodfield