Django项目生成api文档 之 apidoc（4）

最新推荐文章于 2021-03-23 10:25:46 发布
最新推荐文章于 2021-03-23 10:25:46 发布
阅读量453 收藏 1
点赞数 1
分类专栏： django 文章标签： python django
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41601960/article/details/103615411
版权

文章目录

ApiDoc

这篇文章总结一下apidoc项目的文档结构和细节内容。

1.apidoc的细节说明

  1. docs目录为apidoc生成目录(除了apidoc.json、header.md、footer.md外，均为自动生成文档)
    在这里插入图片描述

  2. apidoc.json 为apidoc的主要配置文档，可以设置api文档页面的信息
    apidoc.json的一些参数

  3. header.md 可以设置api文档页面的header部分(此例中Introduction的部分)
    header.md控制api文档页面内容

  4. footer.md 控制api文档页面的footer部分(此例中Best practices的部分)
    footer.md控制的页面内容

  5. apidoc/apps/modules/views.py 中的注释为 modules 的 API 注释

  6. apidoc/apps/project/views.py 中的注释为 project 的 API 注释(详细的语法见 apidoc官网)




  7. api文档的路径配置

8.自动生成api文档

cmd命令：apidoc -i [api注释代码所在的目录] -o [api文档的输出目录]

注意：每次重新自动生成api文档内容，需要先将docs中自动生成的文件（除了apidoc.json、header.md、footer.md外，均为自动生成文档）删除

2.运行

  1. 浏览器打开网址：http://127.0.0.1:8000/docs/index.html
Chandra Chen
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
python 接口代码自动生成_Django 自动生成api接口文档教程
weixin_32512451的博客
02-09 653
最近在写测试平台，需要实现一个节点服务器的api,正好在用django，准备使用djangorestframework插件实现。需求实现一个接口，在调用时，通过传递的参数，直接运行对应项目的自动化测试环境Python3.6 ,PyCharm,W7项目结构功能实现流程我们要做的就是实现以上流程安装pip install djangorestframeworkpip install markdownp...
DRF 框架总结 - 自动生成接口文档
qyf__123的博客
12-14 1979
自动生成接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自APIView及其子类的视图。 1. 安装依赖 REST framewrok生成接口文档需要coreapi库的支持。 pip install coreapi 2. 设置接口文档访问路径 在总路由中添加接口文档路径。 文档路由对应的视图配置为rest_frame...
配置django 接口文档docs
David_no1的博客
03-23 1023
配置django的接口文档docs 1、安装包 django在使用coreapi时AssertionError: coreapi must be installed for schema support. pip install coreapi pyyaml 2、首先打开你的项目的urls,在里面导包： from rest_framework.documentation import include_docs_urls 并在下面配置docs的路径： url(r'docs/',include_docs_u
Django项目生成api文档 之 apidoc（3）
Chandra的学习之路
12-19 227
文章目录APIDOC 之 Pythondoc 样式apiDoc参数@apiDefine@api APIDOC 之 Pythondoc 样式 apiDoc通过源代码中的API注释创建文档。 apiDoc参数 @apiDefine @apiDefine name [title] [description] [title] [description] .... Tips：类似自定义函数的用法...
Django 自动生成api接口文档教程
01-03
最近在写测试平台，需要实现一个节点服务器的api,正好在用django，准备使用djangorestframework插件实现。 需求 实现一个接口，在调用时，通过传递的参数，直接运行对应项目的自动化测试 环境 Python3.6 ,PyCharm,W7 项目结构 功能实现 流程 我们要做的就是实现以上流程 安装 pip install djangorestframework pip install markdown pip install django-filter # Filtering support 配置 INSTALLED_APPS = ( ... 'rest_fr
Django restful framework生成API文档过程详解
12-16
本文将深入探讨如何使用 Django Restful Framework 结合 `django-rest-swagger` 库来生成 API 文档。 首先，我们来看第一步，安装 `django-rest-swagger`。这是一个用于 Django Restful Framework 的 UI 组件，能够...
使用Django编写api接口文档
09-26
使用 Django 编写 API 接口文档 Django 是一个基于 Python 的...使用 Django 编写 API 接口文档需要安装 Django 和 Django rest framework，然后创建应用，定义模型、视图和 URL 配置，最后生成 Swagger 接口文档。
基于Django 3.2的RESTful API企业级项目模板源码
最新发布
03-25
本项目是基于 Django 3.2 的企业级 RESTful API 项目模板，采用 Python 作为主要开发语言，同时包含 Shell 脚本。整个模板包含 107 个文件，具体包括：76 个 Python 源代码文件，10 个模板文件，7 个文本文件，2 个 ...
【接口文档】Django restful framework中自动生成API文档
Allen . Liu
02-25 1880
Django restful framework中自动生成API文档 自动生成api文档（不管是函数视图还是类视图都能显示） 1.安装rest_framework_swagger库 pip install django-rest-swagger 2.在项目下的 urls.py 中加入如下： from rest_framework_swagger.views import get_sw...
CMDB建设补充：教你用django+drf 怎么去生成漂亮的API文档
热门推荐
www.shuaibo.wang|王帅博
06-14 1万+
废话不多说，先看效果图 安装插件 pip install drf_yasg 在settings.py的INSTALLED_APPS里添加drf_yasg 在urls.py里面添加下面代码 from rest_framework import permissions from drf_yasg.views import get_schema_view from drf_yasg import o...
Web开发-Django初识及实战
周先森爱吃素的博客
02-17 459
Django入门
Django知识总结(三)
aa123kk78011的专栏
02-01 209
拾伍 ● Ajax技术 一 ● Ajax定义 Ajax: 异步的 JavaScript 和 XML (Asynchronous+Javascript+XML) 通过Ajax, 我们可以在不重新加载整个网页的情况下，对网页的某部分进行更新(重新加载整个网页是: 雕版印刷, 对网页的某个部分进行更新: 活字印刷) ※...
Django restframework 自动生成api文档
Bob欧巴のblog
07-11 5260
自动生成api接口文档,是restframework自带的功能,生成的文档超级详细,既省去了后端人员写文档的时间,也能让前端用起来欲仙欲死. 不过因为是restframework的功能,目前只能生成调用了restframework类视图的接口,普通的view视图接口不会生成,当然这只是我自己测试了一下后得出的结论,可能有别的方法,这里就不讨论这个,咱们进入正题 restframework 自动...
django如何生成自带的接口文档
咸鱼!!!
06-18 1855
安装依赖包 前期安装了djangorestframework的不必安装第一个依赖 pip install djangorestframework pip install coreapi 前期安装了djangorestframework的不必 配置setting 配置setting INSTALLED_APPS = [ .... 'rest_framework', ] 配置一级...
django自动生成接口文档
paul0926的博客
06-18 8279
django自动生成接口文档先pip安装coreapi包导出pip所有的包到txt文件中配置，在urls.py在serializers.py文件设置备注 先pip安装coreapi包 pip install coreapi 导出pip所有的包到txt文件中 pip freeze > requestment.txt 这个是从文件里用pip安装所有的包 pip install -r requ...
使用apiDoc进行python接口文档编写
小菜的博客
04-26 4611
apiDoc的安装 npm install apidoc -g 点击官方文档 生成api的终端命令：apidoc -i 代码所在路径-o 生成文件的路径 接口文档的编写 文件的简介 project的介绍写在单独的json文件中apidoc.json： { "name": "project_name", "version": "0.1.0", "de...
【Python】Django生成API 文档
星辰大海
10-12 651
全局配置 # 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.
Django项目生成api文档 之 apidoc（2）
Chandra的学习之路
12-18 204
规范自动生成api文档代码 在前面一篇文章，已经能够构造一个api文档了。在这里要纠正之前的一个错误观点。 错误观点：然而按照之前的方式，一个.py文件只能写一个api文档的内容。 观点来源：前面的错误观点来自于，作者在同一个.py文件中，发现不同同时插入两个 """xxxx """ 类似这样的注释api信息。 正       ...
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 到 ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值