.net API 的接口文档查看网站 ApiView

.net API 的接口文档查看网站 ApiView

  • 开源协议:Apache
  • 操作系统: Windows Linux OS X
  • 开发语言:C#
  • 项目所有者:chejiangyi
  • 收录时间:2016-07-25
  • 分享:
编辑评级
3

项目详细介绍

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

by 车江毅
安装包
使用git下载项目并打开目录 “\安装包\” 可直接安装使用

使用Demo示例

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using BSF.BaseService.OpenApi.Attributes;
using BSF.Extensions;
using BSF.Api;

namespace ApiViewTestWeb.Controllers
{
public class DemoController:Controller
{
//
// GET: /Demo/

[OpenDoc("Index","test method","参数描述","结果描述","结果状态描述","作者",1.0,1.0,"备注")]
public string Index(int a,string b,float d)
{
return a+b.NullToEmpty()+d;
}

[OpenDoc("某一店铺的商品列表V15", "某一店铺的商品列表V15",
@"token:token(可选参数),
商户账号:shopid,
类目id:categoryid int?,
关键词:keyword,
条形码: barcode,
显示数量:pageSize ,
页码:pageIndex",
@"活动序号(Int):hdxh,
商品条码(string):sptm,
商品名称(string):spmc,
规格型号(string):ggxh,
计量单位(string):jldw,
商品图片(string):sptp,
图片修改时间(string):sptpxgsj,
原零售价(Decimal):original_lsj,
零售价(Decimal):lsj,
商品销量(Decimal):spxl,
是否活动商品(int):isActivity,
活动总数量(Decimal):hdzsl,
每人限购数量(Decimal):mrxgsl,
", "-5缺少参数", "车江毅", 1.5, 1.5, "")]
public ActionResult List(string shopid, int? categoryid, string keyword, string barcode, long? pageSize, long? pageIndex)
{
    return Json( new ServiceResult() { code=1, data="测试数据", msg="成功", total=1 });
}
}
}



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

部分截图



标签:接口文档查看  api