2017-12-31 20 views
0

Django Restフレームワークでは、AutoSchemaクラスを使用してドキュメントページを作成しています。選択したAPIエンドポイントについては、manual_fieldsを使用してさまざまなフィールドのdocエントリを追加しています。これらのエントリは、prettyテーブルで期待どおりのdocページに表示されますが、description引数をcoreapi.Field()コンストラクタに含めていても、 "Description"カラムは空白です。どのように説明をテーブルに表示させるのですか?Django restフレームワークのフィールドの説明が空白

class FooList(APIView): 
''' List the Foos 
'''    
schema = AutoSchema(
    manual_fields=[ 
    coreapi.Field(
     name='format', 
    location='query', 
    description='The format in which to return results. One of: api, json', 
    required=False), 
     ] 
    ) 

def get(request, format=None): 
    ... 

答えて

1

使用coreschemaモジュールそのAPI-shcema /またはAPIドキュメントが/正しく表示されるフィールドを記述するために:ここで

は、例えば、フィールド定義です。例:

schema=coreschema.String(title='Format', description='The format in which to return results. One of: api, json'), 

schema = AutoSchema(
     manual_fields=[ 
     coreapi.Field(
      name='format', 
      location='query', 
      schema=coreschema.String(description='The format in which to return results. One of: api, json'), 
      required=False), 
      ] 
     ) 
+3

回答を構成する方法についての説明を追加する必要があります。解決した問題を指摘してください。それ以外の場合は、質問からコピーされたテキストのように見えます。 – Sunil

関連する問題