39.Django_类视图_coreapi生成接口文档

最新推荐文章于 2024-07-08 14:55:01 发布
最新推荐文章于 2024-07-08 14:55:01 发布
阅读量2.3k 收藏 6
点赞数
分类专栏： Django
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34400745/article/details/104001721
版权
本文档介绍了如何在Django项目中使用类视图和CoreAPI生成接口文档，包括安装第三方库、配置文件设置、URL路径添加、视图注释以及如何访问生成的接口文档。
摘要由CSDN通过智能技术生成

这一节看一下api接口文档的生成；
使用coreapi生成：

1.安装第三方库：

pip3 install coreapi

2.配置文件中添加配置

在settings.py文件中

REST_FRAMEWORK = {
   
    # 指定用于支持coreapi的Schema
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

3.项目urls文件中添加路径

在urls.py中添加文档路径

#2. coreapi文档需要进行的导入信息
from rest_fram
最低0.47元/天 解锁文章
橘九。
关注
  • 0
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
django中的DRF框架的coreapi和swagger自动生成接口文档
2301_76931745的博客
08-07 672
1）单⼀⽅法的视图，可直接使⽤类视图的⽂档字符串，如2）包含多个⽅法的视图，在类视图的⽂档字符串中，分开⽅法定义，如3）对于视图集ViewSet，仍在类视图的文档字符串中分开定义，但是应使用action名称区分，如。
Python库 | django_core_api-0.1.0rc3-py3-none-any.whlPython库 | dja
05-30
资源分类：Python库 所属语言：Python 使用前提资源：分需类要：解P压y t资h源o全n名库：d j所属an语言go：_Pcytohroen_ a使p用i前-提0：.需1要.解0压r c资3源-全p名y：3d-jnaonneg-oa_nyc.owrhel_ a资p源i来-源0：.官1方. 安0装rc方3法：-hptyt3p-sn:on/e/-laannyz.awohl. b资lo源g来源.c：官sd方 n安.装ne方t法/：ahtrttpiscl:e///dleatnazialos/.b1l0o1g7.8c4s0d5n9.net/article/details/101784059
Django_coreapi生成接口文档(djangorf的，写注释更方便）
Ataoker的博客
07-10 586
在urls.py 中添加文档路径, (在外层url文件，或应用内的都行)模型中定义的verbose_name 和 help_text 也会被用到。另一种方式，三个字符串注释，写在方法下面（优先级更优先）在settings.py文件中。
Django 自动生成api接口文档教程
最新发布
m0_70669463的博客
07-08 449
最近在写测试平台，需要实现一个节点服务器的api,正好在用django，准备使用djangorestframework插件实现。
Django obtainauthtoken coreapi.field(
developer_zhao的博客
05-06 273
该报错提示大概率是因为drf和coreapi的版本不兼容导致的报错,需要查询drf和coreapi配套的版本。
Python-CoreDocs一个API文档生成器
08-10
CoreDocs：一个 API 文档生成器
Django+RestFramework API接口及接口文档并返回json数据操作
09-16
- 接下来，通过pip安装Django和DRF，以及用于生成接口文档的coreapi和pygments、markdown库： ``` pip install django==2.1.5 pip install djangorestframework pip install coreapi pygments markdown ``` 2...
DRF 自动生成接口文档.doc
07-12
在本文档中，我们将介绍如何使用 Django Rest Framework (DRF) 自动生成接口文档。自动化生成接口文档可以减少 手动编写文档的工作量，并且可以确保文档的准确性和最新性。 什么是接口文档？ ---------------- ...
tg-apicore:在Django REST框架之上的自以为是的API框架
05-18
根据您的视图自动生成的API文档 可以添加一般介绍 您可以添加示例请求/响应数据 自动生成的基于Python请求的示例 尚未互动 集成 可配置页面大小的光标分页 用于对列表/详细信息/编辑端点使用不同的序列化器和查询集...
Django中文学习文档
02-25
Django中文学习文档作为入门级的PDF资料，涉及了Django框架的核心内容，包括从安装配置到模型、视图、模板、表单处理，以及安全性、国际化、性能优化等多方面的知识点。下面我将详细介绍文档中涉及的各个知识点： 1...
drf-yasg：从Django REST框架代码自动生成真正的SwaggerOpenAPI 2.0模式
02-05
`drf-yasg`是一个Django REST框架的第三方库，能够根据你的代码自动生成符合Swagger OpenAPI 2.0规范的API文档，这对于开发者和API使用者来说都是极大的便利。 **OpenAPI 2.0简介** OpenAPI规范，之前称为Swagger ...
django document
08-24
django 官方文档，清晰齐全。包含入门示例， API 参考等。
Python库 | coreapi-1.24.0.tar.gz
05-13
资源分类：Python库 所属语言：Python 资源全名：coreapi-1.24.0.tar.gz 资源来源：官方 安装方法：https://lanzao.blog.csdn.net/article/details/101784059
Django新手入门教程（7）编写第一个API
qq_41240287的博客
07-29 301
首先，引入必要的模块和库 from django.http import HttpResponse, JsonResponse import json from django.core import serializers from rsprocess.models import * 在view中新增一个方法，方法名为getGisInfo() def getGisInfo(request): if request.method == 'GET': res = Gis_inf
Django之DRF-生成接口文档和swagger
weixin_47454485的博客
07-21 3285
一、功能简介 生成API文档平台 自动生成测试代码 支持接口测试 二、安装 coreapi（必须） Pygments（可选） MarkDown（可选 三、使用coreapi 1.最新版的DRF（>3.10）中，需要在全局配置文件settings.py中添加如下配置,可在DRF中查看版本 REST_FRAMEWORK = { # 指定支持coreapi的Schema 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.
3.DjangoRestFramework【API文档的使用】
qq_35653657的博客
02-05 248
在开发中需要前端后端开发人员实现约定数据接口的地址、类型、参数、返回值等。口头协定肯定不行。需要有API文档。DRF自带了一套自动生成API文档的工具(有点专业)。
DRF自动生成API方法--coreapi
passion
12-04 3717
DRF 自动生成API # pip install coreapi from django.urls import path from rest_framework.documentation import include_docs_urls urlpatterns = [ # 如果存在权限的问题，加上 authenticatio...
【Python】Django生成API 文档
星辰大海
10-12 660
全局配置 # DRF 全局配置 REST_FRAMEWORK = { 'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema', } 在总路由文件 urls.py 中 from rest_framework.documentation import include_docs_urls urlpatterns = [ path('docs/', include_docs_urls(title="DRF.
python api接口生成_Django 自动生成api接口文档教程
05-30
生成 Django API 接口文档一般可以通过以下步骤实现： 1. 安装 Django-rest-swagger 可以通过 pip 安装 Django-rest-swagger： ``` pip install django-rest-swagger ``` 2. 添加 Django-rest-swagger 到 INSTALLED_APPS 在 settings.py 文件中添加 Django-rest-swagger 到 INSTALLED_APPS： ```python INSTALLED_APPS = [ ... 'rest_framework', 'rest_framework_swagger', ... ] ``` 3. 添加 Django-rest-swagger 的 URL 到项目的 URL 配置文件 在项目的 URL 配置文件（例如 urls.py）中添加 Django-rest-swagger 的 URL： ```python from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title='API 文档') urlpatterns = [ ... url(r'^docs/$', schema_view), ... ] ``` 4. 添加 API 文档注释 在 API 视图函数中，添加类似以下的注释，用于生成 API 文档： ```python from rest_framework.decorators import api_view, schema from rest_framework.response import Response from rest_framework.schemas import AutoSchema @api_view(['GET']) @schema(AutoSchema(manual_fields=[ coreapi.Field(name="param1", required=True, location='query', schema=coreschema.Integer()), coreapi.Field(name="param2", required=True, location='query', schema=coreschema.Integer()), ])) def my_api_view(request): """ API endpoint documentation example. --- parameters: - name: param1 description: Parameter description required: true type: integer paramType: query - name: param2 description: Parameter description required: true type: integer paramType: query """ # Implementation return Response(...) ``` 5. 运行项目 运行项目后，访问 http://localhost:8000/docs/ 即可看到生成的 API 文档。 以上步骤是生成 Django API 接口文档的一种方法，也可以使用其他的工具或框架来实现。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值