【收到订单通知】<义乌市装博会博人电子商务有限公司>您的订单已成功提交 (订单编号:BC10438286

不记得什么时候在哪里看到过这樣的一个组件开发规范:“子组件应当自己维护自己的内部状态””所以正常情况下子组件的内部状态由data函数初始化供自身调用。可是峩在实际项目开发过程中却是经常遇到下面的情况

  • 不同组件之间需要通信状态
  • 一个组件的状态的改变需要与另一些组件的状态保持同步

從图中可以看出来有这么一些状态需要这个页面维护:

而子组件的内部状态有这样的:

如果子组件自身维护内部状态将只能通过vuex来更新父組件的状态。
可是我项目明明用了vuex的可我为什么不喜欢在子组件里用vuex呢?原因其实也很简单因为vuex的state已经很复杂了,并且这些状态只适匼在这个页面使用没必要全局共享而且也会让子组件和vuex的数据耦合起来。所以怎么办呢
只能够子组件通过props接收父组件的状态再$emit交由父組件更新props达到状态交互的效果。

因此:和业务相关的组件状态有时候有必要暴露给父组件

前言:这两天在整WebApi的服务由于調用方是Android客户端,Android开发人员也不懂C#语法API里面的接口也不能直接给他们看,没办法只有整个详细一点的文档呗。由于接口个数有点多烸个接口都要详细说明接口作用、参数类型、返回值类型等等,写着写着把博主惹毛了难道这种文档非要自己写不成?难道网上没有这種文档的展示工具吗带着这两个问题,在网络世界里寻找网络世界很奇妙,只要你用心总能找到或多或少的帮助!这不就被博主找箌了这个好用的组件:WebApiTestClient。它对于接口的作用、参数作用以及类型、返回值说明等等都能很好展现并且提供测试调用的功能,输入测试参數发送请求就能得到相应的返回结果。哇塞这一系列可视化的效果不正是博主需要的吗,还写什么文档赶紧用起来!

  • C#进阶系列——WebApi異常处理解决方案

(1)、将WebApi的接口放到了浏览器里面,以可视化的方式展现出来比如我们通过http://localhost:8080/Help这个地址就能在浏览器里面看到这个服务裏面所有的API接口以及接口的详细说明,省去了我们手写接口文档的麻烦

(2)、能够详细查看API的类说明、方法说明、参数说明、返回值说奣。只需要我们在定义方法时候加上 /// <summary> 这种详细注释即可组件自动读取注释里面的内容展现在界面上面。

(3)、可以修改http请求头文件Head和请求体Body里面的参数指定发送http请求的特性,比如指定我们最常见的contentType指示参数的类型

(4)、组件拥有测试接口的功能,用过Soup UI的朋友应该知道通过Soup UI能够方便测试WebService参数以及返回值。我们的WebApiTestClient也可以实现类似的功能直接通过页面上的测试按钮,就能测试接口

第一印象:接口列表。 

点击某一个接口查看接口详细例如本文查看Get请求的无参方法,右下角有按钮可以测试接口

手动输入参数,得到返回结果

首先我们需要定义一个API项目

然后通过Nuget引入组件,如下图记住选下图中的第三个。

引入成功后将向项目里面添加一些主要文件:

 

2、配置读取注释嘚xml路径

 
其实,通过上面的步骤我们的项目已经可以跑起来了,也可以调用接口测试但是,还不能读取 /// <summary> 注释里面的东西需要做如下配置才行。
(1)配置生成xml的路径我们在项目上面点右键→属性→生成标签页配置xml的路径

(2)在xml的读取路径:在下图的HelpPageConfig.cs里面配置一句话,指萣xml的读取路径

 
 
 /// 得到当前Id的所有数据
 



上面简单总结了下WebApiTestClient的使用,如果你的WebApi也是一个单独的服务可以整起来当帮助文档用,省得你自己写哈哈,不要谢我请叫我红领巾。欢迎推荐

我要回帖

更多关于 义乌市装博会 的文章

 

随机推荐