自定义Django REST框架的架构文档

时间:2019-12-06 10:13:15

标签: django django-rest-framework yaml documentation-generation

我正在尝试使用API​​的内置REST文档来记录我的API。我得到它渲染所有端点,这很棒。现在,我想自定义架构,但不确定如何实现。我知道swagger有一个模式生成器,但是我想调整django已经提供给我的内容。

到目前为止,我正在这样做:

API_TITLE = "title"
API_DESCRIPTION = "description"

urlpatterns = [
    path('docs/', include_docs_urls(
        title=API_TITLE, description=API_DESCRIPTION, permission_classes=[IsAdminUser])
         ),

这使我所有的端点。我添加了屏幕截图。例如,我想填写到目前为止的空白字段的描述。我也想删除一些东西。

我不清楚如何使用架构以及如何在django中使用它们以及如何使用它们。我也找不到我能理解的文档。我知道它们是.yml格式,但是如何获取和操作它们呢?或者我该如何建立自己的?

有人可以帮我吗?在此先感谢,非常感谢!

例如,我想删除灰色框并在说明中填入空白。

Some endpoints of my api

0 个答案:

没有答案