deveel.webhooksダウンロードdeveel.webhooksソースコードのダウンロード

deveel.webhooks

その他のカテゴリー

v2.2.1

ダウンロード

Deveel Webhooks

このプロジェクトは、イベントへのサブスクリプションの管理、基本的な変換、およびそのようなイベントの発生（ Webhooks ）の通知のための一連の.NETツールを提供します。グローバルな設計範囲では、このモデルでは、他のシステムからの予想される発生時にイベント駆動型アーキテクチャ、システムプロセスをトリガーします。

この統合モデルは、主要なサービスプロバイダー（ SendGrid 、 Twilio 、 Github 、 Slackなど）によって広く採用されていますが、コンプライアンスを強制する正式なプロトコルや権限はありません（OpenID、Openapiなどの他のケースなど）。

とにかく、典型的な実装は次の要素で構成されています。

WebHookは、 HTTPポストコールバックを介してトランスポートされます
WebHookペイロードはJSONオブジェクトとしてフォーマットされます（または、XMLまたはフォームとして、あまり一般的ではないシナリオで）
Webhookペイロードには、イベントの種類と発生のタイムスタンプを説明するプロパティが含まれています
リクエストのヘッダーまたはクエリストリングパラメーターのオプションの署名により、発信者の信頼性が保証されます

このリポジトリ内のこのページで、このページで概念をより詳細に表現しようとしました（教育を受けられるという野心なし）。

フレームワークライブラリ

フレームワークによって現在提供されているライブラリは次のとおりです。

図書館	ヌゲット	github（prerelease）
deveel.webhooks
deveel.webhooks.sender
deveel.webhooks.service
deveel.webhooks.mongodb
deveel.webhooks.entityframework
deveel.webhooks.dynamiclinq
deveel.webhooks.receiver.aspnetcore

次のライブラリは、特定のプロバイダーのレシーバーを使用してフレームワークを拡張します。

図書館	ヌゲット	github（prerelease）
deveel.webhooks.receiver.twilio
deveel.webhooks.receiver.sendgrid
deveel.webhooks.receiver.facebook

Nuget公式チャンネルからこれらのライブラリの安定したバージョンを取得できます。

パッケージの最新のプレリリースバージョンを取得するには、Deveelパッケージマネージャーから復元できます。

ドキュメント

このフレームワークを始めて、最終的に拡張するのを手伝いたいと思います。ドキュメントセクション、または私たちがあなたのために作成した公式ウェブサイトを参照してください。

開始する最も簡単な方法は、 Getting Start Guideに従うことですが、最も一般的な質問への回答を得るために、よくある質問セクションを参照することもできます。

モチベーション

.NET Core 3.1/.NET 5 PAAS （ Platform-as-a-service ）プロジェクトに取り組んでいる間、サービスのユーザーの機能を機能的に必要とするプロジェクトでは、HTTPチャネルを通じてシステム間サブスクリプションとイベントの通知を作成できることを機能させることができました（通常はWebhooks 、またはHTTPコールバックと呼ばれます）。そのような野望に不満を抱いています：

MicrosoftのASP.NET WebHooksプロジェクトはアーカイブされ、Microsoft ASP Labs（リリースで可視性がありません）に戻り、.NET Coreとの互換性を提供するために1日目を向けました（最終的に進化し、LTSになりました）
Microsoftの両方のプロジェクト（レガシーと実験的なプロジェクト）は、最新の.NETスタック（ .NET 5 / .NET 6 ）と互換性がありません。
Microsoftの実験プロジェクトは、サブスクリプションを処理する機能を実装することはなく、最終的に送信者機能を削除し、レシーバーのみに焦点を当てました
同様の機能を提供する代替の実装は、より大きなフレームワーク（ASP.NETボイラープレートなど）の埋め込みと有機部品が埋め込まれています。

簡単な使用例

フレームワークのドキュメントでは、フレームワークの要件、構成、使用、および拡張性の詳細が提供されます。

とにかく、フレームワークを始めるのを助けるために、シンプルなWebhook管理サービスを作成する方法、サブスクリプションと通知を処理する方法、クライアントレシーバーを示す次の例を検討してください。

サブスクリプションと通知

サービスプロバイダーとして、このライブラリは、Webhookパターンの2つの主要な側面を処理する機能を提供します。

サブスクリプション：特定のイベントを購読するクライアントの機能。通知されるエンドポイントを提供する
通知：サブスクライブされたエンドポイントに通知を送信するサーバーの機能

次の例は、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メッセンジャーメッセージに裏付けられている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 ( ) ;
        }
    }
}