简介:今天,首席CTO注释要与您分享Django如何介绍API_VIEW的相关内容。如果您可以添加以解决所面临的问题,请不要忘记注意此网站,让我们立即开始吧!
使用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
二十四
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文件,然后将其复制到指定的目录。此部署也非常简单,您可以参考:
看来是否这样写是没有错误的。这是错误的吗?它应该是视图,对吗?
根据您的指导方法来看上面的图片,仅跑步视图就可以了
但是,它不能在Django中使用。运行Django项目时,当前目录实际上是整个项目的根目录
您可以在视图目录中使用无关OS,然后打印(OS.GetCWD())查看当前目录:
当前目录打印是整个项目的根目录。我的是E:mypythonday51 ... blw:
你在这里g:.... nnno:
您必须在Anno目录中导入data_model.py。您是否必须带上应用名称才能输入子级目录?
而且还有一个问题:在未来的开发中,它很可能在不同应用程序下具有同名模块或方法。例如,您在这里有三个应用程序,App01,App02,App03,这三个应用程序具有COMMON_MODEL。那么区别到底是什么?因此,最好将应用程序名称带到前面。
但是真的想使用它,您可以使用:来自.common_model导入data_model
[。]指当前文件的目录,该目录是相对路径导入的
结论:以上是首席CTO介绍给您如何引入API_VIEW的所有内容。我希望这对每个人都会有所帮助。如果您想了解有关此信息的更多信息,请记住要收集对该网站的关注。