deveel.webhooks下载deveel.webhooks源代码下载

deveel.webhooks

其他类别

v2.2.1

下载

Deveel Webhooks

该项目提供了一组.NET工具，用于管理事件，基本转换和此类事件事件的通知（ Webhooks ）：在全球设计范围内，该模型启用了事件驱动的架构，并在其他系统发生预期的发生时触发系统过程。

尽管此集成模型被主要服务提供商（例如SendGrid ， Twilio ， Github ， Slack等）广泛采用，但没有正式的协议或权限可以执行合规性（例如对于其他情况，例如OpenID，OpenAPI等）。

无论如何，典型的实现包括以下元素：

Webhooks通过HTTP后回调运输
webhook有效载荷被格式化为JSON对象（或者在较少的常见方案中，作为XML或表单）
Webhook有效载荷包括描述事件类型和发生时间戳的属性
请求标题或查询串线参数的可选签名确保呼叫者的真实性

我试图在此资料库中的此页面中更详细地表达这些概念（没有任何教学的野心）。

框架库

框架当前提供的库如下：

图书馆	nuget	github（预发行）
deveel.webhooks
deveel.webhooks.sender
deveel.webhooks.service
deveel.webhooks.mongodb
deveel.webhooks.entityframework
deveel.webhooks.dynamiclinq
deveel.webhooks.receiver.aspnetcore

以下库将框架扩展到特定提供者的接收器：

图书馆	nuget	github（预发行）
deveel.webhooks.receiver.twilio
deveel.webhooks.receiver.sendgrid
deveel.webhooks.receiver.facebook

您可以从Nuget官方频道获得这些库的稳定版本。

要获取可以从Deveel软件包管理器还原的包装的最新释放版本。

文档

我们想帮助您开始此框架并最终将其扩展：请参考文档部分或我们为您制作的官方网站。

最简单的入门方法是遵循“入门指南”，但您还可以参考常见问题部分，以获取最常见问题的答案。

动机

在从事.NET Core 3.1/.NET 5 PAA （平台-As-Service ）项目的同时，该项目需要功能，该服务的用户能够能够通过HTTP渠道创建系统到系统到系统的订阅和事件的通知（通常是命名的Webhooks ，或HTTP PARKENT ），以避免我的设计，但我避免了我的设计，以避免我的设计，以避免使用该练习。在这种野心中感到沮丧：

Microsoft的ASP.NET Webhooks项目已存档，然后移至Microsoft ASP Labs（其发行版本没有可见性），旨在有一天提供与.NET Core的兼容性（最终进化，成为LTS）
Microsoft的项目（遗产和实验性的项目）都与最新的.NET堆栈不兼容（ .NET 5 / .NET 6 ）
微软的实验项目从未实现任何处理订阅的能力，并最终删除了发送者的功能，专注于接收器
提供类似功能的替代实现是嵌入式和较大框架的有机部分（例如ASP.NET样板），这将迫使我采用整个此类框架，而不是我的设计意图

简单用法示例

该框架的文档将为您提供有关框架的要求，配置，使用和可扩展性的更多详细信息。

无论如何，为了帮助您开始框架，请考虑以下示例，这些示例显示了如何创建简单的Webhook管理服务，处理订阅和通知以及客户端接收器。

订阅和通知

作为服务提供商，该库提供了处理Webhook模式的两个主要方面的功能：

订阅：客户订阅特定事件的能力，提供端点要通知
通知：服务器将通知发送到订阅端点的功能

以下示例显示了如何创建Webhook订阅，以及如何将通知发送到订户端点：

 using Microsoft . AspNetCore . Builder ;

using Deveel . Webhooks ;

namespace Example {
    public class Program {
        public static void Main ( string [ ] args ) {
            var builder = WebApplication . CreateBuilder ( args ) ;
            
            // ...

            builder . Services . AddWebhookSubscriptions < MongoWebhookSubscription > ( subs => { 
                subs . UseMongoDb ( "mongodb://localhost:27017" )
                    . UseSubscriptionResolver ( ) ;
            } ) ;
				
            builder . Services . AddWebhookNotifier < MyWebhook > ( notifier => {
                notifier . UseSender ( sender => {
                   sender . Configure ( options => {
                        options . Timeout = TimeSpan . FromSeconds ( 30 ) ;
                   } ) ;
               } ) ;
            } ) ;

            var app = builder . Build ( ) ;

            // ...

            // ... and notify the receivers manually ...
            app . MapPost ( "/webhooks" , async ( HttpContext context , 
                [ FromServices ] IWebhookSender < MyWebhook > sender , [ FromBody ] MyWebhookModel webhook ) => {
                var destination = webhook . Destination . ToWebhookDestination ( ) ;
                var result = await sender . SendAsync ( destination , webhook , context . HttpContext . RequestAborted ) ;

                // ...

                return Results . Ok ( ) ;
            } ) ;

            // ... or notify the webhooks automatically from subscriptions
            app . MapPost ( "/webhooks/notify" , async ( HttpContext context , 
                [ FromServices ] IWebhookNotifier < MyWebhook > notifier , [ FromBody ] MyEventModel eventModel ) => {
                var eventInfo = eventModel . AsEventInfo ( ) ;
                var result = await notifier . NotifyAsync ( eventInfo , context . HttpContext . RequestAborted ) ;

                // you can log the result of the notification to all receivers ...
                return Results . Ok ( ) ;
            } ) ;

            app . Run ( ) ;
        }
    }
}

接收者

该框架还提供了一组内置的接收器，可用于从应用程序中的订阅端点处理传入通知。

以下示例显示了如何为由Facebook Messenger消息支持的Webhook创建接收器：

 namespace Example {
    public class Program {
        public static void Main ( string [ ] args ) {
            var builder = WebApplication . CreateBuilder ( args ) ;
            
            // ...

            builder . Services . AddFacebookReceiver ( )
                . AddHandler < MyFacebookWebhookHandler > ( ) ;

            var app = builder . Build ( ) ;

            // ...

            // ... you can handle all the incoming webhooks at "/webhooks/facebook"
            // invoking all the handlers registered in the service collection ...
            app . MapFacebookWebhook ( "/webhooks/facebook" ) ;

            // ... or you can handle the incoming webhooks manually ...

            app . MapFacebookWebhook ( "/webhooks/facebook2" , async ( FacebookWebhook webhook , IService service , CancellationToken ct ) => {
                // ...
                await service . DoSomethingAsync ( webhook , ct ) ;
            } ) ;

            app . Run ( ) ;
        }
    }
}