django-rest-framework 및 swagger API 문서

Question

프로젝트를 보니 django-rest-swagger 프로젝트를보고 api 문서화에 사용하고 싶습니다. 그러나 그것을하는 방법에 대한 몇 가지 질문이 있습니다.

1. 모델 또는 시리얼 라이저에서 help_text 속성을 사용하는 방법은 무엇입니까? 설명서에서 "필드 help_text 속성은 serializer 또는 모델에서 설명을 만드는 데 사용됩니다." 그러나 API 문서에는 필드 이름과 필드 유형 만 포함되어 있으며 기본값은 없습니다 (예 : 필드 색상).

   Response Class 
   CigarSerializer { 
       name (string), 
       url (url, optional), 
       colour (string), 
       price (decimal), 
       length (integer), 
       gauge (integer), 
       notes (string), 
       id (integer, optional), 
       manufacturer (field) 
   } 
   

   API 문서에 help_text 속성을 포함 할 수 있습니까?

2. API 문서에 시리얼 라이저 문서 문자열을 포함 할 수 있습니까?

Answer 1

위의 serializer 정의가 올바르지 않습니다. 다음은 serializer를 help_text으로 정의해야하는 방법입니다.

class CigarSerializer(serializers.ModelSerializer): 
    url = fields.URLField(source='get_absolute_url', read_only=True, help_text="this is where you add help text") 
    ... 

    class Meta: 
     model = models.Cigar