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

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

开源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;配置如下：

<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 车江毅

转载于:https://www.cnblogs.com/chejiangyi/p/5552685.html

【开源】.Net Api开放接口文档网站相关推荐

api数据接口文档_接口文档示例（Taobao/jd/pinduoduo/开放接口调用）
api数据接口文档_接口文档示例本文主要是提供了一个接口文档的范文,内容修订历史.目录.时序图.接口要素描述.接口说明.使用示例.字典.FAQ. 使用MD格式文档(makedown),选择原因,容 ...
小程序、微信公众号调用监控摄像头直播开放接口文档
为了满足各行业用户使用监控视频直播业务需求,云事通公司拟定发布基于WEB方式,M3U8视频调用对接接口如下,前端需要部署我们智能网关,然后推流到我们云平台,支持市场主流监控摄像头厂商的接入,欢迎大家咨 ...
pushplus 开放接口文档
pushplus 开放接口文档 V1.0 1.0 接口更新日期:2021-12-21 通过accessKey调用消息.用户.群组.渠道配置和功能设置接口 pushplus官网地址:http://www ...
laravel api生成接口文档
安装 composer require foryoufeng/laravel-doc 如果报错: composer更新报错问题Carbon 1 is deprecated, see how to mi ...
A股api交易接口文档怎么使用？
A股api交易接口是在股票量化交易中常用到的一种量化工具,对于它的用法,小编针对性的以文档的例子说明: 交易接口API 功能概述: 名称功能基本函数 Init API 初始化 Deinit API ...
快递100企业版物流快递查询接口（API）接口文档-详细加长版
快递100物流查询接口现已支持1200家常用的快递及物流公司单号查询.快递网点电话查询.快递价格查询.快递网上寄件服务.近期快递100物流查询接口推出针对部分B2C商城以及移动手机应用需要快递单号查询 ...
收款云音箱云喇叭API开发接口文档（2020-4-20）
云音箱服务对接指南一.名词解释 1.云音箱 ID (SPEAKERID): 云音箱机身上帖有云音箱的 ID 码,每台云音箱拥有唯一永久 ID,SPEAKERID由字母.数字组成, 在生产过程中写入 ...
API登录接口文档事例
1. 登录接口请求URL http://域名/auth/login 请求方式 POST 请求参数参数名参数类型是否必填参数说明 username string 是用户名 password ...
Django API接口文档使用说明
Django API接口文档 REST framework可以自动帮助我们生成接口文档. 接口文档以网页的方式呈现. 自动接口文档能生成的是继承自APIView及其子类的视图. 1. 安装依赖 RES ...

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

【开源】.Net Api开放接口文档网站相关推荐

最新文章

热门文章