文档章节

【开源】.Net Api开放接口文档网站

车江毅
 车江毅
发布于 2016/06/02 12:45
字数 688
阅读 843
收藏 8

开源地址:http://git.oschina.net/chejiangyi/ApiView

开源QQ群: .net 开源基础服务  238543768

ApiView

.net api的接口文档查看网站,用于解决分布式开发过程中的Api接口管理和沟通问题。
- 自动生成api文档;
- 方便api调试及第三方开发人员对接,可以应用在asp.net mvc,wcf,webservice 中使用;
- 代码及原理都很简单,方便二次开发和完善。


by 车江毅


安装包
使用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站点“帮助文档”中“重新加载”按钮生效。

 

部分截图

© 著作权归作者所有

车江毅

车江毅

粉丝 233
博文 24
码字总数 40199
作品 13
杭州
架构师
私信 提问
开发工具总结(7)之多年珍藏的Android开发必备网站和工具

【前言】工欲善其事,必先利其器。搞开发多年了,会收藏一些干货网站和工具,辅助开发,提高开发效率。下面一次性分享给大家。喜欢的朋友们点个赞吧。 说明:这些是我收藏的网站,感觉还是不...

AWeiLoveAndroid
2018/01/08
0
0
龙果支付开源项目对账接口介绍

龙果支付开源项目对账接口介绍 一、 微信对账接口(微信支付和对账接口都很规范) 1. api的地址 https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_6 2. 对接过程中按照接口要求...

芝麻绿豆
2016/08/28
651
0
接口管理系统开源版 --eoLinker

一.概况 eoLinker API Management System(AMS)是一款帮助企业开发人员进行在线管理接口文档、进行自动化测试、团队协作的工具,它旨在提高企业项目的接口管理水平,提升开发速度并且降低运...

ProLinker
2017/11/27
2.7K
9
接口管理系统 eoLinker-AMS 开源版 V3.1.7 正式发布

eoLinker API Management System(AMS)是一款帮助企业开发人员进行在线管理接口文档、进行自动化测试、团队协作的工具,它旨在提高企业项目的接口管理水平,提升开发速度并且降低运维成本。...

彦臣
2017/12/14
2.6K
12
ENTBOOST 0.2.0 Windows版本发布,开源企业IM

经过恩布团队全体成员的不懈努力,按照原定计划,终于在今天(5月14日)发布第二个开源版本,恩布企业互联IM,ENTBOOST 0.2.0(r174beta)Windows版本;主要功能支持文本、表情,图片,文件共...

akee
2014/05/14
1K
12

没有更多内容

加载失败,请刷新页面

加载更多

php 遇到 No input file specified的解决方法

(一)IIS Noinput file specified 方法一:改PHP.ini中的doc_root行,打开ini文件注释掉此行,然后重启IIS 方法二: 请修改php.ini 找到 ; cgi.force_redirect = 1 去掉前面分号,把后面的1...

chenhongjiang
今天
5
0
MySQL 基础

一、常用命令 在命令行中,配置好环境变量后,通过cmd可以直接进入mysql命令行模式,同时列举几种常用命令 # 进入mysql数据库,密码可以先不写,打完-p后再输入,防止被别人看到mysql -u账...

华山猛男
今天
6
0
简单的博客系统(四)Django请求HTML页面视图信息--基于函数的视图

1. 编写用于查询数据的功能函数 应用目录 下的 views.py 文件通常用于保存响应各种请求的函数或类 from django.shortcuts import renderfrom .models import BlogArticles# Create your ...

ZeroBit
今天
5
0
用脚本将本地照片库批量导入到Day One中

因为目前iCloud 空间已经不足,其中95%都是照片,之前入手了DayOne,且空间没有限制,订阅费一年也不少,再加上DayOne作为一款日记App 也比较有名,功能方面最大的就是地理视图与照片视图,尤...

在山的那边
昨天
21
0
jupyter部署安装

python373 -m ipykernel install --name python373 ipython kernelspec list sc create myjupyterservice binpath="D:\apply\Python373\Scripts\jupyter-notebook --config=V:/my_work/jupyt......

mbzhong
昨天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部