FastHttpApi 控制器 JavaScript 生成插件安装与使用指南

作者:代码拾荒时间:2026-10-22 18:23:45浏览:79

本文详细介绍 FastHttpApi 组件配套的 JavaScript 自动生成插件的安装流程与使用方法。该插件支持 VS2017,通过设置自定义工具 JSAPI,可在保存控制器时自动封装 API 脚本。生成的脚本依赖 FastHttpApi.js,提供同步、异步及 await 调用方式,并支持 WebSocket 与 HTTP 通道切换,旨在简化前端接口调用开发。

前言

前言

由于组件未提供 view 服务引擎,在开发应用网站时需由 JavaScript 调用接口以整合 UI,这使得编写访问接口的代码变得繁琐。为此,组件提供了一个自定义工具插件,用于自动生成控制器对应的访问脚本(目前该插件仅支持 VS2017)。安装插件后,可对控制器文件设置自定义工具名称,一旦控制器类保存,系统将立即生成相应的调用脚本。

下面话不多说了,来一起看看详细的介绍吧

插件安装步骤

下载安装插件

下载插件

前言

双击安装插件。安装完成后,只需在控制器类的文件属性中,将“自定义工具”设置为 JSAPI 即可。

生成内容解析

生成内容

通过插件生成的 JavaScript 文件仅是对 API 的二次封装,其基础功能依赖于 FastHttpApi.js。因此,在引用控制器 API 调用脚本前,必须先引用 FastHttpApi.js。插件会为控制器的每个方法生成对应的调用脚本,每个方法包含一个 url 属性、一个异步调用方法以及一个支持 await 调用的方法。


var $Hello$url='/hello';
function $Hello(name,useHttp)
{
 return api($Hello$url,{name:name},useHttp).sync();
}
function $Hello$async(name,useHttp)
{
 return api($Hello$url,{name:name},useHttp);
}

使用方式


await $Hello('test');
$Hello$async().execute(function(result){});

调用机制与使用方式

调用机制

脚本支持两种调用方式。当 WebSocket 连接处于激活状态时,默认通过 WebSocket 通道进行通信。若希望仅基于 HTTP 调用,可将 useHttp 参数指定为 true。


await $Hello('test',true);
$Hello$async(true).execute(function(result){});

总结

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对本站的支持。

作者最新文章