gpt4 book ai didi

django - DRF 3.6 : How to document input parameters in APIView (for automatic doc generation)?

转载 作者:行者123 更新时间:2023-12-03 23:54:04 25 4
gpt4 key购买 nike

我正在为 DRF 3.6 auto-generated interactive documentation 苦苦挣扎提供输入参数填写交互模式。

结果,我的 POST 请求得到一个空窗口(实际上需要 3 个参数):

enter image description here

使用 Swagger,我可以直接在带有一些 YAML 的文档字符串中完成。
现在,浏览 DRF 文档后,我找不到方法。

class ActivateCustomerView(APIView):

permission_classes = (AllowAny,)

def post(self, request):
""" View dedicated to activating a pre-recorded customer
# Should I add some parameters here?
"""

serializer = ActivateCustomerSerializer(data=request.data)
serializer.is_valid(raise_exception=True)
# ...

最佳答案

我从汤姆克里斯蒂那里得到了答案:
serializer_class仅靠它本身是不够的 - View 需要实现 get_serializer,参见:https://github.com/encode/django-rest-framework/blob/master/rest_framework/schemas.py#L570

所以在我的情况下,添加这个效果很好:

def get_serializer(self):
return ActivateCustomerSerializer()

关于django - DRF 3.6 : How to document input parameters in APIView (for automatic doc generation)?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/43771032/

25 4 0