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

最新推荐文章于 2022-03-07 16:15:36 发布
原创 最新推荐文章于 2022-03-07 16:15:36 发布 · 619 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#python #django

本文详细介绍apidoc项目文档结构及生成流程，包括apidoc.json配置、注释规范、自动生成命令及运行方式，助您快速掌握API文档自动化生成技巧。

文章目录

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
【Django-DRF框架】生成各种API接口文档
python全栈
05-21 1247
方式一： 安装 pipenv install coreapi pipenv install Pygments pipenv install Markdown 配置 REST_FRAMEWORK = { ...... #指定用于支持coreapi的Schema 'DEFAULT_SCHEMA_CLASS':'rest_framework.schemas.coreapi.AutoSchema' } 在全局路由条目中，定义路由条目 from rest_framework.documen
Python-Django使用apidoc接口文档
阿茂丶
04-09 8421
最近工作中有用到apidoc，感觉很方便，记录一下... 都是链接地址，比较懒... 1)参照：安装apidoc 2)将docs文件夹(包括apidoc.json和header.md)拷贝到自己方便的位置，没有的话就创建两个文件，比如我的就是放在了static静态文件夹下 3）按照要求书写接口文档，参照：使用apidoc 生成Restful web Api文档 4）在docs文件夹下...
Django 自动生成api接口文档教程
09-18
今天小编就为大家分享一篇Django 自动生成api接口文档教程，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
python Web框架 Django学习(4) API
weixin_30734435的博客
12-30 79
记录了一下实践过的API 都能用，具体估计就我能看懂。看不懂的留言。。 # 查看数据库对应所有数据对象 对象名.objects.all() # 读取指定ID的数据(返回对象) 对象名.objects.filter(id=1) # 获取具体数据 对象名.objects.get((id|pk)=1) (如果没有就抛异常) # 一对多关联 p=对象...
Django项目生成api文档 之 apidoc（1）
Chandra的学习之路
12-17 1148
一、安装apidoc 1.Node.js 安装配置 Step1：下载Node.js安装包 下载地址为：https://nodejs.org/en/download/ Step2：安装Node.JS 1）双击下载下来的安装包v12.13.1,点击运行，然后一路next （后面有遇到一个勾选框的页面，忽略，继续next） 2）默认安装目录为 “C:\Program Files\nodejs” , ...
Django项目生成api文档 之 apidoc（2）
Chandra的学习之路
12-18 258
规范自动生成api文档代码 在前面一篇文章，已经能够构造一个api文档了。在这里要纠正之前的一个错误观点。 错误观点：然而按照之前的方式，一个.py文件只能写一个api文档的内容。 观点来源：前面的错误观点来自于，作者在同一个.py文件中，发现不同同时插入两个 """xxxx """ 类似这样的注释api信息。 正       ...
Django项目生成api文档 之 apidoc（3）
Chandra的学习之路
12-19 364
文章目录APIDOC 之 Pythondoc 样式apiDoc参数@apiDefine@api APIDOC 之 Pythondoc 样式 apiDoc通过源代码中的API注释创建文档。 apiDoc参数 @apiDefine @apiDefine name [title] [description] [title] [description] .... Tips：类似自定义函数的用法...
Django-自动生成API文档
qq_33537936的博客
02-22 3766
自动生成API文档一、安装二、添加配置 一、安装 需要安装以下几个包（如果有虚拟环境需要进入虚拟环境安装） coreapi（必须） Pygments（可选） Markdown（可选） 二、添加配置 3.10版本以上的DRF，需要添加配置信息，在setting.py文件的REST_FRAMEWORK中，添加如下代码： REST_FRAMEWORK = { # 指定用于支持coreapi的Schema 'DEFAULT_SCHEMA_CLASS': 'rest_framework.sche
django集成Sphinx，为项目自动生成文档
轻编程的博客
03-07 1149
Sphinx是一个工具，可以轻松创建智能和漂亮的文档，他与Python自带的pydoc是同一类产品，但比pydoc更加优秀，还有很多主题可以选择，平时在开发过程中，我们看到的第三方包的文档，基本上都是用该模块自动生成的，今天我就带大家手把手将其集成到django项目当中，使其为我们的django项目自动生成文档！ 创建一个django的Demo项目 # 创建虚拟环境 python3 -m venv venv # 激活虚拟环境 venv\Scripts\activate ## windown
使用sphinx生成API文档
12-06
5. **生成代码文档**：回到项目根目录，使用`sphinx-apidoc`命令生成API文档。 ```bash cd .. sphinx-apidoc -o doc/source/ doc/ ``` 这里`-o`后面跟随的是存储`.rst`文件的路径，`doc/`是你想要生成API文档...
使用apiDoc实现python接口文档编写
01-02
apiDoc的安装 npm install apidoc -g 点击官方文档 生成api的终端命令：apidoc -i 代码所在路径-o 生成文件的路径 接口文档的编写 文件的简介 project的介绍写在单独的json文件中apidoc.json： { name: project_name, version: 0.1.0, description: who am i ,what i can do , title: title of the html that generated by apiDoc, sampleUrl : https:/
django使用apidoc生成rest_fromwork类型接口文档
墓地行者的博客
09-23 800
django使用apidoc生成rest_fromwork类型接口文档 文档相关： Git地址：https://github.com/apidoc/apidoc 项目地址：http://apidocjs.com/ 样例项目：http://apidocjs.com/example_basic/ 安装和使用： a. 安装apidoc：在操作系统中运行 > npm install apidoc -...
django的apidoc使用,拥有自己的api文档
wangjun491280的博客
06-09 458
一、使用步骤 1、安装apidoc，需要安装node哦 npm install apidoc -g
Django RESTful API (4) 认证和权限
super1peng的博客
03-14 1340
欢迎关注个人微信公众号，大大大碗面，不定期分享AI论文解读和开发技术，互联网小白，轻喷~ 前言 按照前面几篇文章的介绍，使用Django编写RESTful API的基本功能已经像模像样了。我们可以通过不同的URL访问到不同的资源，通过不同的HTTP请求来实现对资源的不同操作。 但是现在我们的API还有一个明显的缺陷，那就是没有认证和权限功能，任何资源都会被任何用户随意更改，所以我们要改进程序，实...
DRF 框架总结 - 自动生成接口文档
qyf__123的博客
12-14 2106
自动生成接口文档 REST framework可以自动帮助我们生成接口文档。 接口文档以网页的方式呈现。 自动接口文档能生成的是继承自APIView及其子类的视图。 1. 安装依赖 REST framewrok生成接口文档需要coreapi库的支持。 pip install coreapi 2. 设置接口文档访问路径 在总路由中添加接口文档路径。 文档路由对应的视图配置为rest_frame...
使用apiDoc进行python接口文档编写
小菜的博客
04-26 4726
apiDoc的安装 npm install apidoc -g 点击官方文档 生成api的终端命令：apidoc -i 代码所在路径-o 生成文件的路径 接口文档的编写 文件的简介 project的介绍写在单独的json文件中apidoc.json： { "name": "project_name", "version": "0.1.0", "de...
刨析Django----API接口文档
weixin_45228198的博客
02-27 835
注册的API 地址url: http://127.0.0.1:8000/v1/users/register/ 请求方法： POST 提交数据： 举例说明 需要的响应： {“code”:200, “xx”,…} {“code”:204, “xx”,…} 字段说明 #别名的指定 from .views import index from users.views import index as users_index from goods.views import index as goods_index #
配置django 接口文档docs
David_no1的博客
03-23 1360
配置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
pycharm如何一键生成api文档
最新发布
07-06
在 PyCharm 中生成 API 文档可以通过集成第...PyCharm 插件市场也提供了多个辅助文档生成的插件，如 `Docstring Generator`、`Swagger` 插件等，这些插件可以帮助开发者更高效地编写注释并生成结构化的 API 文档[^4]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值