为WebService的 WebMethod 添加方法描述说明
Web Service是一个平*立的,低耦合的,自包含的、基于可编程的web的应用程序,可使用开放的XML(标准通用标记语言下的一个子集)标准来描述、发布、发现、协调和配置这些应用程序,用于开发分布式的交互操作的应用程序。我们知道WebService的 WebMethod是可以添加方法描述Description的并且“Description”里面可以放超文本如下图所示:
添加方法如下:
下面展示一些
内联代码片
。
[WebService(Namespace = "http://192.168.1.30/WebServiceData.asmx",Description = @"<h4>机动车考试监管系统数据上传下载Web服务<h4></br>")]
下面展示一些 内联代码片
。
[WebMethod (Description = @"<h2>查询类接口说明:</h2>
<p>
<h4>查询类方法:public String QueryObjectOut(String xtlb,String jkxlh,String jkid,String QueryXmlDoc)</h4>
<h4>查询类接口调用参数说明:</h4>
xtlb 系统类别 接口提供者的业务类别代码,默认为“17”(代表机动车考试监管系统);</br>
如: xtlb=17;</br>
jkxlh 接口序列号 由外挂系统请求服务平台授权生成下发;</br>
如:jkxlh=“791F0909030617040815E6958E9DFF8FFC9E39343238575840746D72692E636E”。;</br>
jkid 接口标识 5位,由系统类别+C+两位接口顺序号组成,用于唯一表示一个接口。;</br>
如: jkid=17c04;</br>
QueryXmlDoc 查询条件 封装查询条件的XML格式文档;</br>
<h4>返回数据</h4>
返回结果文档ResultXML;</br>
<h4>查询条件QueryXmlDoc的文档格式要求如下:</h4>
<pre>
<!-- 查询条件QueryXmlDoc的文档格式要求如下:-- >
< ?xml version= ""1.0"" encoding=""utf - 8"">
< root >
< QueryCondition > <!--节点标签-->
< fzjg > 532002384 < /fzjg > <!--发证机关-->
< gxsj > 2021/10/10 </gxsj > <!--更新时间-->
< /QueryCondition >
< /root >
</pre></br>
<h4>返回结果错误代码说明:</h4>
<pre>
<!-- 返回结果错误代码说明:-- >
<!-- 正常返回结果code为成功与否标记(小于等于0-失败;1-成功,由提供的接口服务定义),
网络异常或接口权限异常等系统原因时返回$E的标记。写入失败时的message返回详细描述信息。-->
code标记定义如下:
Code值 说明
1 验证通过
0 已经验证通过
-1 考生无预约信息
-2 约考日期不是今天
-3 考生当天考试次数已达到2次
-4 预约信息与考生身份信息不符
-5 科目考试系统使用状态不正常
-6 无考生分组详细信息
-7 考试员信息不符
-8 考试场地使用状态不正常
-9 科目考试系统时间异常
$E 系统异常-->
<?xml version=""1.0"" encoding=""utf-8"" ?>
<root>
<head>
<code> 1</code>
<message>数据下载成功</message>
<rownum>1</rownum>
</head>
<body>
<vioSurveil id = ""0"">
<jkfs >0 </jkfs >......< /vioSurveil >
<vioSurveil id = ""1"">
<jkfs >0 </jkfs >......< /vioSurveil >
</body >
</root >
</pre></br>
</p> </br>")]
下面展示一些 内联代码片
。
public string QueryObjectOut(String xtlb, String jkxlh, String jkid, String QueryXmlDoc)
{
//程序代码
}