.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.APIView DRF框架的视图的基类是 APIView APIView的基本使用和View类似 Django默认的View请求对象是 HttpRequest，REST framework 的请求对象是 Request。 Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。 HttpRequest.GET ————> Request.query_params HttpReq
-
1.前后端分离 前： 主要以页面的美观和流程，兼容三部分 后：主要以三高 业务耦合 需要懂数据库、懂框架操作、懂模版前端 指责划分不明确 会造成团队之间沟通混乱，代码不统一，前后端技能水平层次不齐的水平 成本高 本质上这些软件 APP 用的都是同一套数据，由于不分离的情况，还需要给每一个平台不同的 APP 开发多套后端，这个开发成本很高 服务器压力大 渲染页面本应该是在客户端完成，如今都是在服务端
-
1.前后端不分离 缺点 业务耦合较强 指责划分不明确 开发成本较高 服务器压力较大 在服务端渲染页面返回给用户，在高并发情况下会占用大量资源 优点 提高SEO速度，提高搜索引擎收录检索速度 页面数据都是渲染好返回的 2.前后端分离 概念 前：浏览器 HTML、CSS、Bootstrap、JS、JQuery、Vue、NodeJS、webpack 体验为主：炫酷、流畅、兼容 后：服务器 Jvm、spr
-
1.APIview使用、 https://www.cnblogs.com/xiaonq/p/10124104.html ModelVIewSet 是对 APIView 封装 ModelSerializer 是对 Serializer 1.1 在 user/urls.py 中添加路由 urlpatterns = [ path(‘apiview/’, views.UserInfoViewSet.as_
-
APIView DRF 为了更符合 restful api 规范，在 View 上层做了一层封装，就是 APIView，View 本身没有权限和认证以及限流等的操作，只做请求的分发，然后返回，里面就是一些简单的分发逻辑，但APIView不同，重写了 as_view方法，里面做了认证、限流、权限、渲染很多东西。 这种视图还不够通用，需要自己写一些分页、序列化、queryset 之类的东西。 clas
-
url.py path('books/', BookView.as_view()) view.py class BookView(APIView): pass 1.我们看自己是否有as_view()方法，没有，那我们就来到继承的APIView类中 view = super().as_view(**initkwargs) # 这是调用了父类View的as_View方法 re
-
1. 标题栏 NT_UI.setHeader(name, style); 列表 可选值 背景色 颜色 悬浮色 大小 间距 圆角 标题栏 wrapper true 标题栏-客服头像 kefuLogo true true true 标题栏-客服名称 kefuName true 标题栏-客服个性签名 kefuSignature true 标题栏-最小化按钮 min true true 标题栏-关闭按钮
-
初始化 xn('init') 停止默认初始化 xn('stopAutoInit'); 设置访客信息 // customerinfo的可选健值见下表 xn('setCustomerInfo', JSONObject customerinfo); 参数名称 类型 备注 默认值 uid String 用户id 无 uname String 用户名称 无 userlevel String 用户等级
-
对于某些应用程序来说，窗口查看围绕特定主题的多个文档是很有用的。上下文视图能够帮助设置包含时序性事件的索引模式。 想要显示与锚文档相关的上下文，点击文档表条目左侧的 Expand 按钮 ，然后点击 View surrounding documents 链接。 上下文视图会显示锚文档前后的多个文档。锚文档会用蓝色突出显示。该视图是根据索引模式配置的时间字段而检索出的结果，并使用 Discover 浏
-
提交一个搜索查询后，Documents 表中就会列出500个匹配查询的最新文档。您可以通过 Advanced Settings 中的 discover:sampleSize 设置表中显示的文档个数。默认情况下，该表显示的是为所选索引模式和文本 _source 配置的时间域的本地化版本。 您可以从 Fields 表中选择字段向 Documents 表中添加。您可以通过表中包含的任意索引字段对所列文档
-
为方便 Cocos Creator 开发者调试和接入腾讯云游戏多媒体引擎产品 API，本文为通过 Cocos Service 服务面板，接入腾讯云 GME 的接口文档。 此文档对应 GME SDK 的版本为 2.5.2。 函数原型为 GME Cocos SDK 接口文档 中定义的接口，Cocos Service 接入时设置了一个全局变量 tencentGME.tencentGMEInst，可参考示
-
ethers.js 主要包含以下4个模块 ： 钱包（Wallet） ，Providers ，合约 Contract 以及 工具包 utils 。 在使用接口之前，请先确保正确 引入 ethers.js ， 以下是接口列表： 钱包类 Wallet 和 签名器 Signer Wallet 签名器（Signer） 接口 提供者 Provider 连接以太坊网络 属性 获取网络 获取账号信息 获取以太坊状
-
目前我正在开发一个应用程序，允许用户创建一个模板并将其生成为DOCX文件。应用程序需要能够在用户创建模板时向用户显示模板中的更改。 我尝试的方法是使用DOCX4J库（允许操作DOCX文件）和ICEPDF，后者主要用于通过将DOCX首先转换为PDF文件来将其显示到swing组件中。现在，这种方法的问题是加载速度非常慢，DOCX文件中发生的一些更改没有反映在PDF转换中（例如：虚线下划线、字体更改）。
-
1. PHP开发接口文档 1.1 发送消息 发送文本、图片、语音消息到小能服务器。 备注：http请求方式为POST方式，格式为XML。 使用样例： class SendMsg{ function send($message){ //发送消息地址 $url = "https://thirdparty.ntalker.com/wechat"; $header[] = "Content-type: