为什么在apiDocjs中将@apiDefine与@apiPermission一起使用?

时间:2019-11-23 16:38:50

标签: django django-rest-framework api-doc

我正在使用apiDocjs来记录我的API。

我必须定义一些权限,但是当我仅使用@apiPermission时,此行仅显示为纯文本。在此之前添加@apiDefine(https://apidocjs.com/#param-api-define)时-我没有收到任何错误,但似乎没有任何改变。我认为它至少会使它显示为带有HTML标题的文本。

那么,在@apiPermission之前使用@apiDefine有什么意义?

我是一个初学者,无论是否使用@apiDefine,我都看不到任何区别-这两个HTML在我看来都是一样的。

这是代码的一部分:

class ArticleList(generics.ListAPIView):
    """
    @apiDefine Authenticated user    Only logged in users can use this functionality
    """
    """
    @api {get} / Retrieve all articles
    @apiName GetArticles
    @apiGroup Articles
    @apiPermission Authenticated user

    @apiSuccess {Object[]} articles    List of articles.
    @apiSuccess {Number} id            ID of the article
    @apiSuccess {String} author        Name of the author 
    @apiSuccess {String} title         Title of the article
    @apiSuccess {String} body          Text of the article
    @apiSuccess {Date} created_at      Date when the article was published

下图显示了HTML的外观。 The resulting HTML

谢谢!

0 个答案:

没有答案