WeChatMiniProgController Class

用于微信小程序扫码的控制器的默认实现。

Definition

Namespace: QuickAdmin.RCL.Controllers
Assembly: QuickAdmin.Net (in QuickAdmin.Net.dll) Version: 1.1.6
C#
public class WeChatMiniProgController : RCLAPIControllerBase
Inheritance
object    ControllerBase    RCLAPIControllerBase    WeChatMiniProgController

Remarks

此控制器内置 API 在 EnableInnerWeChatMiniProgAPI == true 才可用。

可利用此类以及 WeChatMiniProgService 快速实现自己的微信小程序扫码 API：从 WeChatMiniProgService 继承实现自己的 Service 并注入系统，然后继承此类实现自己的控制器并指定 Route 即可。
C#
// 第一步：继承 WeChatMiniProgService，填写小程序信息
[UseDI(typeof(IWeChatMiniProgService))]
public class MyMiniProgService : WeChatMiniProgService
{
    protected override string AppId => "你的小程序 AppId";

    protected override string AppSecret => "你的小程序 AppSecret";
}

// 第二步：继承 WeChatMiniProgController 并指定 Route
[Route("api/MyMiniProg/[action]")]
[ApiController]
public class MyMiniProgController : WeChatMiniProgController
{
}

// 第三步：在应用启动时注册 MyMiniProgService，并告知系统你指定的 Route
builder.Services.AddSingleton(typeof(IWeChatMiniProgService), typeof(MyMiniProgService));
QuickAdmin.RCL.RCLHelper.QRCodeApiBaseUrl = "~/api/MyMiniProg/";
实现自己的 API 后将 EnableInnerWeChatMiniProgAPI 配置项置为 false 以确保内置的扫码 API 不会被外部调用。

Constructors

WeChatMiniProgControllerInitializes a new instance of the WeChatMiniProgController class

Properties

Protected Properties

miniProgService 微信小程序扫码服务。

Methods

Public Methods

CheckQRCode 检查二维码。供小程序端在用户扫码时调用。
GetBindAccountQRCodeImage 获取用于扫码绑定账户的二维码图片。供浏览器端调用。
GetLoginQRCodeImage 获取用于扫码登录的二维码图片。供浏览器端调用。
QRCodeAuth 确认授权。供小程序端在用户确认授权后调用。
QRCodeCancel 取消二维码。供小程序端在用户取消授权后，或浏览器端失效该二维码时调用。
RefreshQRCodeStatus 刷新二维码状态。供浏览器端轮询二维码状态时调用。

Protected Methods

CheckRequest 用来检查 API 请求的方法。

See Also