Django-rest-framework: OpenAPI स्कीमा पीढ़ी के लिए SerializerMethodField पर फ़ील्ड प्रकार कैसे सेट करें?

को निर्मित 13 जन॰ 2020 · 3टिप्पणियाँ · स्रोत: encode/django-rest-framework

इस बेकार धारावाहिक पर विचार करें:

class MySerializer(serializers.Serializer):

    random_number = serializers.SerializerMethodField()

    def get_random_number(self):
        # Chosen by fair dice roll.
        # Guaranteed to be random.
        return 4

मान लें कि आपने इस सीरियलाइज़र को एंडपॉइंट में जोड़ा है और ओपनएपीआई स्कीमा जेनरेट किया है, तो सीरियलाइज़र इस तरह दिखेगा:

properties:
  random_number:
    type: string
  required:
  - random_number

यहां मुद्दा यह है कि डीआरएफ को यहां type: number का उपयोग करने के लिए कहने का कोई तरीका नहीं है। मैंने कुछ संभावनाओं के बारे में सोचा:

output_field विशेषता, जैसे serializers.SerializerMethodField(output_field=serializers.IntegerField()) , इसी तरह Django की क्वेरी अभिव्यक्तियों के लिए
एक डेकोरेटर, जैसे openapi_type(serializers.SerializerMethodField(), serializers.IntegerField())

एक विशेषता, व्यवस्थापक क्रियाओं पर विवरण सेट करने के समान:

random_number = serializers.SerializerMethodField()

def get_random_number(self):
  return 4

get_random_number.output_field = serializers.IntegerField()

बस कुछ डीआरएफ समर्थन नहीं करता है, जिसे शायद संभावित चेतावनी के रूप में कहीं दस्तावेज किया जाना चाहिए।

Enhancement Schema Generation

स्रोत

Lucidiot

👍3 👀2

सबसे उपयोगी टिप्पणी

मेरे लिए, मुझे लगता है कि मैं जिस एपीआई को पसंद करूंगा वह टाइप हिंटिंग का उपयोग कर रहा है जैसे:

def get_foo(self, obj) -> int:
    return 1

यह वर्तमान में समर्थित प्रत्येक पायथन संस्करण में काम करता है। इस विचार का उपयोग https://github.com/encode/django-rest-framework/pull/7089 में किया गया था लेकिन इसे दूसरे पीआर में विभाजित नहीं किया गया था। उस कार्यान्वयन को देखते हुए, ऐसा लगता है कि यह संग्रह को संभाल नहीं पाता है। किसी बिंदु पर आप नेस्टेड सीरियलाइज़र का उपयोग करना बेहतर होगा, लेकिन मुझे लगता है कि List[int] , List[str] , Dict[str, int] आदि जैसे साधारण मामलों का समर्थन किया जाना चाहिए।

@carlfarrington आपको क्या लगता है? क्या यह इस दृष्टिकोण को आजमाने लायक है या इसमें कोई समस्या है? यदि यह कोशिश करने लायक है, तो क्या इसमें कुछ बुनियादी चीजें प्राप्त करने लायक हैं जो मूल प्रकारों को संभाल सकती हैं और अभी के लिए नेस्टेड फ़ील्ड को अनदेखा कर सकती हैं या क्या हम शुरू से ही (नेस्टेड या नहीं) सरणियाँ और ऑब्जेक्ट चाहते हैं?

knyghty 16 मार्च 2020

👍3

सभी 3 टिप्पणियाँ

हाय @ लुसीडियट।

मुझे लगता है कि ऐसा करने का तत्काल तरीका AutoSchema._map_field() को ओवरराइड करना होगा।

प्रश्न में क्षेत्र की अपेक्षा करने के लिए आप या तो प्रति-धारावाहिक/दृश्य कर सकते हैं, या एक विशेषता जोड़ सकते हैं जैसे आप कहते हैं।

हम अंततः इस तरह से कुछ के आसपास आएंगे, लेकिन वर्तमान में मैं एपीआई के मामले में सबसे अच्छे विकल्प के बारे में निश्चित नहीं हूं।

carltongibson 21 जन॰ 2020

👍2

def get_foo(self, obj) -> int:
    return 1

knyghty 16 मार्च 2020

👍3

हम 3.12 के लिए map_field() प्रचार और दस्तावेज़ीकरण करेंगे। यहां जाने का यही सही तरीका है।

carltongibson 6 अप्रैल 2020

क्या यह पृष्ठ उपयोगी था?

0 / 5 - 0 रेटिंग्स

Django-rest-framework: OpenAPI स्कीमा पीढ़ी के लिए SerializerMethodField पर फ़ील्ड प्रकार कैसे सेट करें?

सबसे उपयोगी टिप्पणी

सभी 3 टिप्पणियाँ

संबंधित मुद्दों