Question

美好的一天。

我想为我的api制作文档。我用这个库

https://github.com/manosim/django-rest-framework-docs

我需要添加方法说明，但这意味着不起作用https://yadi.sk/i/y3hodAvn3TMRJ3

我的代码

public function getquickviews(Request $request){
     $report = new ReportController();
     $report ->Applications($request->except('cl_e_start_date'));//it's not working its giving me error that it expect and instance of Request and passed array()
}



    public function Applications(Request $request) 
    {
/*APP USAGE*/
     }

我也试过了

def get(self, request):
    """
    description for method
    """

我做错了什么？

Answer 1

您使用了错误的库。从docs开始，您正在使用的库和相关的DRF库用于 -

API端点的文档。
自动生成的代码示例对于每个可用的API客户端库。
支持API互动。

它们不是用于记录您的文档字符串。为此，使用python文档库，如sphinx。

相关链接 - http://docs.python-guide.org/en/latest/writing/documentation/

django-rest-framework-docs方法描述

1 个答案: