为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){}

为WebService添加描述相关推荐

给SQL数据库表和字段添加描述信息
在创建数据库表时,有时怕忘记了字段的作用,要给表的字段加上一些说明文字.而以前要经常切换到表的设计方式去添加一些说明文字,这样总觉得比较麻烦. 刚好查了一下数据库的联机丛书发现还有这样的命令,现在我把 ...
mysql给字段添加描述_用sql 语句给字段添加描述
用sql 语句给字段添加描述 IF not exists (SELECT * FROM ::fn_listextendedproperty (NULL, 'user', 'dbo', 'table', ...
给swagger的接口添加描述
swgger非常便于前后端分离开发,通过给swagger添加描述就可以实现前后端共同的开发接口,以下介绍如何给swagger的接口添加描述. 一.创建实体,并在实体和属性上使用@ApiModel(). ...
MATLAB plot画的图中，添加描述值、添加横坐标数值，加粗字体，加粗折线
可结合柱状图画法,丰富画图经验,柱状图参照:https://blog.csdn.net/wmz13248/article/details/106384341 第1步: text(x,y,num2str ...
c# WebService添加SoapHeader认证
1.添加一个cretificate类继承自SoapHeader public class CertificateSoapHeader:SoapHeader { ...
asp.net webservice 添加get方法
当需要在浏览器中直接访问webservice中的方法时,需要做如下修改 <webServices><protocols><add name="HttpGet&q ...
info.plist文件里面添加描述 - 配置定位,相册等
<key>NSAppleMusicUsageDescription</key> <string>App需要您的同意,才能访问媒体资料库</string> ...
ios 关闭更新（第三方软件添加描述文件）
IOS设备不可以直接禁止系统更新,会在连接Wi-Fi和电源的时候自动下载系统,之后再频繁提醒更新,不胜其烦. 禁止IOS设备更新可以使用PP助手等第三方手机助手. 其操作步骤如下: 1.先去官网下载安 ...
建表添加描述 mysql_MySQL建表语句+添加注释
1.建表+注释 CREATE TABLE student( id INT PRIMARY KEY AUTO_INCREMENT COMMENT '学号', name VARCHAR(200) COMM ...

为WebService添加描述

为WebService添加描述相关推荐

最新文章

热门文章