当前位置: 首页 > 网络应用技术

如何编写Django项目接口文档(Django接口开发经验)

时间:2023-03-08 22:09:12 网络应用技术

  本文将告诉您如何编写Django项目接口文档以及Django接口开发体验的相应知识点。我希望这对您有帮助。不要忘记收集此网站。

  本文目录清单:

  1. DJANGO RESTFRAMEWORK(1):接口和规格2. DJANGO新手教程6,创建一个新项目3. Django Rest Framework + DRF-YASG关于API文档文档网页数据修改方法4.使用Django开发相对简单的帖子界面界面1)使用API关键字标识接口URL

  2)优先选择接口数据安全性确定来选择HTTPS协议

  3)如果界面有多个版本,则需要在URL中的出价中反映

  4)接口参数的数据源称为资源。在URL中,通常使用资源复数形式。一个接口可以总结资源的多重操作方法

  5)有许多请求方法,如何使用URL处理如何确保它不是混乱的,可以通过请求方法识别资源方法

  2)状态代码文本提示

  4)无法直接返回的资源(子资源,图片,视频和其他资源),返回资源的URL链接

  感觉到它将被没有卡片的群众击败,所以让我们开始。

  打开CMD黑色窗口,我们进入

  workon django_env

  让我们看一下如何在黑色窗口中的每个URL之间穿梭。您首先查看您现在的位置。一般来说,新开放的CMD在

  c:/user/your_name

  在这个位置,我们首先转到D驱动器,根目录是从C到D,我们只需要输入

  D:

  您可以到达D驱动器。如果您的django_env被激活,他将自动跳到

  d:/py_env/django_env

  当然,在此目录中,我们可以在这里构建该项目,但是我们也可以在其他地方构建它。请输入(请注意,CD和两个点之间有一个空间)

  CD ..

  CD意味着要去。两个小点是指父亲,这意味着当前目录的父亲目录。

  所以我们来了

  d:/py_env

  在目录中,再次输入

  CD ..

  所以我们到达

  d://

  这是D驱动器的根目录的重新输入CD。不再效果。如果您逐步遵循我的教程,那么您已经在此根目录上构建了一个名为Django_project的空文件夹。如果您还没有建造,请输入

  mkdir django_project

  创建此文件夹。当然,您还可以在图形接口中打开我的计算机,然后正确地单击新文件夹以达到位置。为了强制网格并更熟悉CMD窗口,我建议您仍然使用命令行。

  我们的CMD路径(准确是工作路径)现在在D驱动器的根目录上

  所以,请输入

  CD django_project

  指示转到django_project。当然,目前您必须确定Django_project是D驱动器根目录下的子目录。

  如果我们还在

  D:py_env/django_env

  然后输入

  CD django_project无效。您必须刚刚逐步到达D驱动器,然后输入django_project.or,您可以直接输入绝对路径

  CD d:/django_project

  使用上述命令,只要您在D驱动器上,无论您是哪个目录,都可以一步就位。

  当我们到达现场时,我们将很快建立我们的项目。

  激动人心的时刻在这里,请输入CMD

  django-admin startproject mysite

  目前,我们创建了一个项目,该项目的名称是MySite等,等等。要说良好的云磁盘不是Mao的MyCloud吗?有必要提及Django的微妙之处。一个新项目等同于计算机上的一块土地(d:/django_project/mysite目录是我们网络服务的站点),Andi尚未开始展览馆。您为什么要直接建造一个新的展览馆而不是土地,因为当我们循环时,我们可以在地面上建立许多展览馆。在Django,云磁盘不足以调用一个。该项目只能称为应用程序(一个展览馆)。只有将许多展览馆放在一起,才可以称为该项目,即一个项目可以包含许多应用程序(应用程序)。对于extplecloud磁盘服务,我们还可以提供个人博客服务。我们还可以为植物开设论坛。无论如何,将来要提供家庭水桶服务。因此,云磁盘只能被视为一个应用程序。当然,目前我们只在地面上建立一个展览馆。

  或在CMD黑色窗口中,请输入

  dir

  使用此指令在当前目录中列出子目录和存储文件,

  我们可以看到,生成一个称为MySite的子目录。实际上,山地上有两个目录,一个目录是一个点,这意味着您,即django_project本身,另一个目录是两个点,表明父亲,这意味着父亲。root目录。因此,我们看到的是Django_project目录的三代人。

  这基本上是均匀的,作为图形界面。下图的左上角的位置代表父目录。至于目录本身,无需故意表达它。

  您使用鼠标单击文件夹,实际上,内部系统是为您运行

  CD您单击了文件夹

  如果您点击返回,请帮助您运行

  CD ..

  回到主题,我们看到了一个MySite子目录,所以进去看看,请输入

  CD Mysite

  然后输入

  dir

  检查情况

  我发现还有另一个Mysite目录,Pit父亲,俄罗斯的孩子是!这是!

  在这一点上,我知道Django是外国人的工具。sub -directory称为与父目录相同的名称(无论如何,第一个级别目录的名称是mysite ii.once,我们不能随便更改它。将来,我们将内部称为“ mysite”。mysite,外部的外部称为区别)。细看。旁边还有一个管理。

  其中有4个PY文件。我看到了,其中之一是URLS.PY,URL的重要性,您需要专门管理文件。如果您对文章的读物有认真的阅读,则在urls.py中,settings.py也很重要。它用于管理MySite项目。因此,我认为最后一个mysite文件夹应该称为mysite_manage,因为它的内部是什么,就像在管理中一样。

  为了使每个人都知道对项目结构有更清晰的了解,我在Django的官方网站上找到了图片

  操作_summary:操作名称如下所示

  操作_desscripting:接口简介如下所示

  操作_id:操作方法名称如下所示

  手动_Parameters:在参数中修改参数描述

  request_body:张贴发送内容如下所示

  响应:响应的内容如下所示

  枚举:定义修改后字段的参数值,默认编写第一个字段。如下所示

  描述:字段说明

  类型:字段需要什么类型的数据

  type_object =“对象”

  type_string =“字符串”

  type_number =“数字”

  type_integer =“整数”

  type_boolean =“布尔值”

  type_array =“数组”

  type_file =“文件”

  格式:如何验证

  format_date =“ date”

  format_datetime =“ date time”

  format_password =“密码”

  format_binary =“二进制”

  format_base64 =“字节”

  format_float =“ float”

  format_double =“ double”

  format_int32 =“ int32”

  format_int64 =“ int64”

  format_email =“电子邮件”

  format_ipv4 =“ ipv4”

  format_ipv6 =“ ipv6”

  format_uri =“ uri”

  format_uuid =“ uuid”

  format_slug =“ slug”

  format_decimal =“十进制”

  让我首先谈论前排条件

  1.首先构建django环境win+r打开命令提示符pip安装django

  3.然后创建一个自己的应用程序

  同样,在命令提示符的路径上,输入新创建的项目所在的路径,输入python manage.py startapp xxx(这是指您要创建的名称),您可以看到创新的编辑器可以看到

  4.正式开始开发邮政请求

  首先在seetings.py文件中设置参数以对其进行修改,如图所示

  Views.py

  最后,在模板文件夹下创建一个HTML文件以简单地写下前端

  我直接发布登录。html我在这里写的

  代码部分是要完成效果

  您也可以输入提琴手检查验证。为了找到更好的选择,我们首先打开提琴手,然后输入用户名密码。

  你可以得到这样的包

  用户名,密码的值也与我们输入的输入一致

  在此处完成简单的帖子请求开发

  让我们谈谈如何编写Django项目接口文档。感谢您花时间阅读本网站的内容。有关Django接口开发经验的更多信息,如何编写Django项目接口文档的信息,不要忘记在此网站上找到它。