加入收藏 | 设为首页 | 会员中心 | 我要投稿 李大同 (https://www.lidatong.com.cn/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 综合聚焦 > 服务器 > 安全 > 正文

为WebService添加描述

发布时间:2020-12-17 00:24:38 所属栏目:安全 来源:网络整理
导读:目的 ? ? ? ? 有些时候我们会遇到这样的问题,其他人封装的WebService给我们调用的时候,拿到手的服务描述并不能让我们正确的使用,因为没有任何指导性的说明与描述,因此,在我们开发WebService的时候,别忘了为服务添加描述和参数说明等描述性的注释。 样
  • 目的

? ? ? ? 有些时候我们会遇到这样的问题,其他人封装的WebService给我们调用的时候,拿到手的服务描述并不能让我们正确的使用,因为没有任何指导性的说明与描述,因此,在我们开发WebService的时候,别忘了为服务添加描述和参数说明等描述性的注释。

  • 样例
? ? ? ? 下面的链接是某网站关于快递查询的WebService:http://webservice.36wu.com/ExpressService.asmx

? ? ? ??

支持下列操作。有关正式定义,请查看服务说明。

GetAllByPostId 
通用快递/物流查询

输入参数:快递商(内置枚举类型),单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetCreByPostId 
中铁快运查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetEMSByPostId 
EMS查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetJsonAllByPostId 
通用快递/物流查询(JSON)

输入参数:快递商(内置枚举类型),单号,根据当前单号返回JSON数据,AcceptTime:时间,Remark:跟踪记录
GetSfExpressByPostId 
顺丰速运查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetStoByPostId 
申通速递查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetYtoByPostId 
圆通快递查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetYundaByPostId 
韵达快递查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetZTWLByPostId 
中铁物流查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录
GetZtoByPostId 
中通快递查询

输入参数:单号,根据当前单号返回相关数据信息,AcceptTime:时间,Remark:跟踪记录

? ? ? ? ?我们可以看到服务中的每一个方法都有方法功用说明,并对方法的相关参数进行了注释,这样给人的感觉是不是很COOL!?

  • 给服务添加描述
? ? ? ? ?很简单,在每个方法体上面的位置增加如下注解:

? ? ? ? ?

[WebService(Description="A description of this service...")]

实例:

 [WebMethod(Description = "<b><i>天气查询服务</i></b><br><font color='blue'>string</font> province:省<br><font color='blue'>string</font> city:城市</br><font color='blue'>string</font> date:日期(YYYYMMDD)")]
        public List<T> getCityWeather(string province,string city,string date)
        {

        }

(编辑:李大同)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    推荐文章
      热点阅读