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

Django自动生成界面文档(2023年的最新饰面)

时间:2023-03-07 02:18:24 网络应用技术

  简介:本文的首席执行官注释将向您介绍Django自动生成界面文档的哪些相关内容。我希望这对每个人都会有所帮助。让我们来看看。

  我不知道您想做什么类型的应用程序。web.py轻量级,django可能没有重量。但是,只要您使用数据库,请进行Django开发,您就会感到非常方便。要更改的内核,一般网络应用程序不需要更改任何内核。至少到目前为止,我尚未遇到自己更改内核的情况。换句话说,如果您的级别与内核水平一样高,您不需要纠缠这个问题,您可以自己编写一个框架。

  我个人认为Django非常平衡且易于使用。例如,Django的模型和模板,您可以使用与否,而无需说您必须强迫您。一半 - 知识。

  对于一般网络应用程序,强烈建议使用Django。

  使用Swagger

  Swagger是用于Restful接口的在线自动生成+功能测试功能软件。

  可以说在Web API中使用Swagger非常简单,无需编写任何代码,这完全取决于插件。特定的步骤如下:

  1.创建一个新的Web API项目

  2.与Nuget一起添加Swashbuckle包装

  3.完成

  没错,这就是简单的!运行项目,转到地址,您将看到以下页面。这是默认值添加的两个apicontroller:

  目前,没有具体的描述信息。例如,我们将注释描述添加到valuescontroller.get上,这些描述仍未在页面上显示。您需要按照以下步骤:

  )

  2.将方法代码添加到SwaggerConfig:

  1

  2

  3

  4

  受保护的静态字符串getXmlCommentsPath(字符串名称)

  {{{

  return string.format(@“ {0} bin {1} .xml”,applicoain.currentDomain.basedirectory,name);

  }

  3.修改项目生成,您可以在bin下的相应XML文件下查看特定描述文档,如下:

  重新生成项目,您可以看到完整的接口描述。例如,我们心中的testController如下:

  1

  2

  3

  4

  5

  6

  7

  8

  9

  10

  11

  12

  13

  14

  15

  16

  17

  18

  19

  20

  21

  22

  23

  24

  25

  26

  27

  28

  29

  /// 概括

  ///测试控制器

  ////概括

  公共类测试核心:apicontroller

  {{{

  /// 概括

  ///测试GET方法

  ////概括

  ///备注测试获取方法/备注

  ///返回/返回

  [httpget]

  公共字符串get()

  {{{

  返回“获取”;

  }

  /// 概括

  ///测试帖子方法

  ////概括

  /// param name =“名称”名称/param

  ///参数名称=“年龄”年龄/param

  ///备注测试帖子方法/备注

  ///返回/返回

  [httppost]

  公共字符串帖子(字符串名称,int age)

  {{{

  返回名称 + age.tostring();

  }

  }

  生成的页面如下。您可以看到界面的描述。单击尝试打电话:

  第三,非依赖性代码

  上面的方法取决于Swashbuckle软件包,该软件包已经包含Swagger-UI组件。您的代码需要引入此软件包。实际上,它不能在项目中引入。Swagger-UI(API Display)和Swagger-编辑器(在线编辑器)可以分开部署。根据Nodej。部署实际上非常简单,例如,这是我部署的结果:

  Swagger-编辑:

  Swagger-UI:

  编辑器之后,您只需要将文件保存为JSON文件,然后将其复制到指定的目录。此部署也非常简单,您可以参考:

  让我首先谈论前排条件

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

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

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

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

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

  Views.py

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

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

  代码部分是要完成效果

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

  你可以得到这样的包

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

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

  烧瓶是一个小而细的缩影。它不如Django大。如果由烧瓶开发,开发人员需要确定哪些数据库ORM,模块系统,用户身份验证系统等需要自己形成。

  与Django开发相比,开发人员可能需要花费更多的时间来理解和选择项目开头的每个组件。因此,烧瓶开发更加灵活。开发人员可以根据需要选择适当的插头。

  当然,Flask的历史相对较短,第三方应用程序自然不像Django那样全面。

  结论:以上是首席CTO注释引入的Django自动生成界面文档的所有内容。我希望这对每个人都会有所帮助。如果您想进一步了解这一点,请记住要收集对该网站的关注。