【问题标题】:Documenting a django project (django 2 + drf + drf-access-policy)记录一个 django 项目(django 2 + drf + drf-access-policy)
【发布时间】:2023-03-07 09:12:01
【问题描述】:

我正在记录一个使用 DRF 的 django 项目。我已经使用 openapi 和 redoc 生成了一个动态 API 模式。非常酷的解决方案

但是,我错过了所有这些中的权限部分

我在视图集和一些功能中有很多权限(permission_classes)。您是否知道将权限包含在架构或一般文档中的任何解决方案?

更进一步,您一般如何在 API 中记录权限?

我已经有了一个想法:在架构的自定义描述中包含权限,但它仍然很脏

谢谢。何塞.-

PS: 对不起英文不好

【问题讨论】:

    标签: django django-rest-framework


    【解决方案1】:

    DRF 正在弃用 coreapi 包,但目前在该解决方案中没有简单的方法可以将安全架构添加到您的文档中。

    但是有一个替代方案https://drf-yasg.readthedocs.io/en/stable/ 这个工具声称支持提取这些值(但我个人还没有使用它)。

    【讨论】:

    • "DRF 正在弃用 coreapi 包" --> 很高兴知道。
    • 我认为问题在于 openapi 模式中没有考虑权限。关于 drf-yasg,我在文档中查找“权限”,并且只显示有关架构视图权限类(本身权限)的信息,而不是视图集。还是谢谢朋友
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2020-04-28
    • 1970-01-01
    • 2020-01-14
    • 2019-03-16
    • 2021-06-02
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多