ApiView是.net api的接口文档查看网站,用于解决分布式开发过程中的Api接口管理和沟通问题。 自动生成api文档； 方便调试及第三方开发人员对接，可以应用在asp.net mvc，wcf，webservice 中使用； 代码及原理都很简单，方便修改和完善。
开源QQ群: .net 开源基础服务 238543768
ApiView
.net api的接口文档查看网站,用于解决分布式开发过程中的Api接口管理和沟通问题。
- 自动生成api文档；
- 方便api调试及第三方开发人员对接，可以应用在asp.net mvc，wcf，webservice 中使用；
- 代码及原理都很简单，方便二次开发和完善。
安装包
使用git下载项目并打开目录 “\安装包\” 可直接安装使用
使用Demo示例
1 using System;
2 using System.Collections.Generic;
3 using System.Linq;
4 using System.Web;
5 using System.Web.Mvc;
6 using BSF.BaseService.OpenApi.Attributes;
7 using BSF.Extensions;
8 using BSF.Api;
9
10 namespace ApiViewTestWeb.Controllers
11 {
12 public class DemoController:Controller
13 {
14 //
15 // GET: /Demo/
16
17 [OpenDoc("Index","test method","参数描述","结果描述","结果状态描述","作者",1.0,1.0,"备注")]
18 public string Index(int a,string b,float d)
19 {
20 return a+b.NullToEmpty()+d;
21 }
22
23 [OpenDoc("某一店铺的商品列表V15", "某一店铺的商品列表V15",
24 @"token:token(可选参数),
25 商户账号:shopid,
26 类目id:categoryid int?,
27 关键词:keyword,
28 条形码: barcode,
29 显示数量:pageSize ,
30 页码:pageIndex",
31 @"活动序号(Int):hdxh,
32 商品条码(string):sptm,
33 商品名称(string):spmc,
34 规格型号(string):ggxh,
35 计量单位(string):jldw,
36 商品图片(string):sptp,
37 图片修改时间(string):sptpxgsj,
38 原零售价(Decimal):original_lsj,
39 零售价(Decimal):lsj,
40 商品销量(Decimal):spxl,
41 是否活动商品(int):isActivity,
42 活动总数量(Decimal):hdzsl,
43 每人限购数量(Decimal):mrxgsl,
44 ", "-5缺少参数", "车江毅", 1.5, 1.5, "")]
45 public ActionResult List(string shopid, int? categoryid, string keyword, string barcode, long? pageSize, long? pageIndex)
46 {
47 return Json( new ServiceResult() { code=1, data="测试数据", msg="成功", total=1 });
48 }
49 }
50 }
OpenApi使用说明文档
1.引用BSF.dll和BSF.BaseService.OpenApi.dll
2.在MVC网站Controller下面的接口方法处添加OpenDocAttribute特性注释即可。
3.参考ApiViewTestWeb使用方式中的DemoController。
4.在AppView站点中发布OpenApi的信息。
配置AppView中web.config;配置如下：
<!--多个Api文档可以配置多个DllPath,如DllPath1,DllPath2;
接口dll路径 api程序集路径,多个;分隔 格式：需要公开接口的dll路径;接口名;测试的appurl'-->
<add key="DllPath1"
value="D:\svn-working\RT_Cloud\trunk\源代码\BaseService\ApiView
\ApiViewTestWeb\bin\ApiViewTestWeb.dll;ApiViewTestWeb【示
例】;http://10.17.72.96:8081/"/>
5.点击AppView站点“帮助文档”中“重新加载”按钮生效。
部分截图
by 车江毅
开源是一种态度，分享是一种精神，学习仍需坚持，进步仍需努力，.net生态圈因你我更加美好。