restful专栏 04.API文档的自动生成

最新推荐文章于 2024-07-20 20:24:10 发布

全栈开发

最新推荐文章于 2024-07-20 20:24:10 发布

阅读量233

点赞数

分类专栏： restful 文章标签： restful

本文链接：https://blog.csdn.net/m0_66351881/article/details/124057772

版权

restful 专栏收录该内容

23 篇文章 4 订阅

订阅专栏

# 01.API文档的自动生成

[toc]{type: "ol", level: [2, 3, 4, 5]}

### 安装依赖
```python
pip install coreapi
```
<br><br>


### 创建路由
#### 引入路由
    只能在主文件中进行创建
```python
### project.urls
from rest_framework.documentation import include_docs_urls
    # 创建路由地址
    path("api/v1/docs/", include_docs_urls(title="RestfulAPI", description="RestfulAPI v1 docs"))
```
#### 配置主题样式
```python
### settings.dev
REST_FRAMEWORK = {
    # 配置API文档的主题
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}
```
#### 文档注释
    在views中添加文档注释
![drf](imgs/01.png)
<br><br>