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

Apache
C#
跨平台
2016-06-16
车江毅

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

部分截图

的码云指数为
超过 的项目
加载中

评论(1)

test190318
test190318
可以推荐一下 不过 很久没有更新了

暂无资讯

暂无问答

APIView源码分析(小梅老师版本)

APIView源码: 1.APIView继承了View 原生view 2、APIView类里面有dispatch方法 3、 APIView在原有的基础上,多了很多功能。request:进行了加工,是一个新的对象。 4.请求封装request = self....

2018/07/03 15:49
12
0
django rest framework 外键序列化方法与问题总结

django rest framework 外键序列化方法与问题总结 当借口中需要出现一对多关系的时候,我们可以用rest_framwork的序列化功能来处理,代码如下. # models.py from django.db import models clas...

2018/10/17 23:50
325
0
CMDB 权限 5

import json import random import string import time import datetime import traceback from django.db import transaction from django.db.models import Q from django.shortcuts impor...

02/01 23:19
2
0
django rest framework viewapi

django自带form、modelform,drf有serializer、ModelSerializer与之对应。 drf(django rest framework),提供了强大的Web browsable API,auth第三方登录认证,Serialization,CBV drf自定...

2018/12/09 18:03
28
0
django-rest-framework文件上传接口实现

提供文件上传接口 代码实例 UploadView类提供了文件上传的方法 class UploadView(APIView): ''' 上传文件接口 ''' parser_classes = (MultiPartParser,) def post(self, request, format=N.....

2018/09/08 15:09
628
0
Vue+Django REST framework 打造生鲜电商项目

http://coding.imooc.com/class/chapter/131.html#Anchor mark 第1章 课程介绍 介绍课程目标、通过课程能学习到的内容、和系统开发前需要具备的知识 第2章 开发环境搭建 介绍系统开发所需的...

2017/10/18 12:25
116
0
python教程

1, 序列化 Serialization 创建一个新环境 在做其他事之前,我们会用virtualenv创建一个新的虚拟环境。这将确保我们的包配置与我们正在工作的其他项目完全隔离。 virtualenv env # 创建虚拟环...

2018/07/30 16:53
8
0
【开源】.Net Api开放接口文档网站

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

2016/06/02 12:45
827
0
django views 以及restframe work views和viewsets

django views 以及restframe work views和viewsets

2016/05/30 09:25
84
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部