hexarc pactダウンロードhexarc pactソースコードのダウンロード

hexarc pact

その他のカテゴリー

1.0.0

ダウンロード

ヘキサルク協定

Hexarc Pactは、.NET/TypeScriptベースのプロジェクトのWeb APIを公開および消費するためのツールチェーンを提供します。

.NET Web APIプロジェクトをPACTで開発して、APIメタデータの単一の真実のソースを保持し、.NETエコシステム（マイクロサービス、デスクトップ、モバイルアプリケーション）またはTypeScriptを介してWeb上でそれを消費します。

パッケージ	プラットフォーム	バージョン	ダウンロード
`Hexarch.Pact.Protocol`	.NET 7.0+
`Hexarch.Pact.AspNetCore`	.NET 7.0+
`Hexarch.Pact.Client`	.NET 7.0+
`Hexarch.Pact.Tool`	.NET 7.0+
`@hexarc/pact-tool`	タイプスクリプト

協定は何ですか？

特徴
タイプシステム
APIアノテーションルール
- 追加の属性
デモAPI
使い方
- PACT APIスキーマ（.NET Web APIサービス）を公開する
- PACT APIスキーマ（.NETクライアントアプリケーション）を消費する
謝辞
ライセンス

特徴

秒単位での手間のかからないAPI統合。
タイプ情報が失われません。設計されているように正確なAPIを消費します。
最初にコード。外部IDL/DSLでAPIプロトコルを説明する必要はありません。
高度なタイプで充電されます。単純なDTOだけでなく、酵素、ジェネリック、タグ付き組合など。

タイプシステム

PACTタイプシステムは、最良の開発体験を得るために、いくつかのオーダーメイドのものを持つ.NET CLRタイプに基づいています。

協定タイプのシステム内にあるもの：

プリミティブタイプ（ GuidおよびDateTimeを含む）
値/参照型セマンティクス
コレクションとジェネリック（単純な配列と辞書だけでなく）
ヌル可能な参照型アノテーション（NRT）の完全なサポート
eNums（文字列ベースと数字ベース）
タグ付き組合（hexarc.serialization.union経由）
タプル（hexarc.serialization.tuple経由）

APIアノテーションルール

PACT APIスキーマは、RPCのようなセマンティックを持つように設計されています。そうすることで、露出したAPIはこれらのルールに従う必要があります。

APIコントローラーには、標準のApiControllerおよびRoute属性でマークされている必要があります。
ルート属性には、テンプレートなしで一定の文字列パスのみが必要です（例： [Route("Entities")] ）。
APIメソッドは、サポートされているHTTP動詞の1つ（ HttpGetまたはHttpPost ）でマークする必要があります。動詞属性にはエンドポイントパスが含まれる場合があります。その他は現時点ではサポートされていません。
- HttpGetメソッドには、 FromQuery属性を介してバインドする必要があるクエリパラメーターを使用できます。
- HttpPostメソッドには、要求本体であるパラメーターが1つだけ含まれている必要があります。
APIメソッドパスは、HTTP動詞属性またはRoute属性で指定できます。メソッドパスがHTTP動詞属性で指定されていない場合、 Route 1から取得されるか、例外が発生します。

追加の属性

PACTは、APIアノテーションにいくつかの有用な属性を提供します。

PactIgnoreAttribute 、APIスキーマから除外するAPIコントローラーまたは方法に適用できます。
PactScopeAttribute APIコントローラーに適用して、APIスキーマの特定の範囲に分離できます。

デモAPIサーバー

デモAPIサーバーは、https：//hexarc-demo-api.herokuapp.com/にあります。

PACT APIスキーマは、https：//hexarc-demo-api.herokuapp.com/pact/schemaに公開されています。

APIクライアントを生成するには、以下の命令を使用します。

使い方

PACTを使用して典型的なWeb APIを公開および消費する方法をご覧ください。

PACT APIスキーマを公開します

Hexarc.Pact.AspNetCoreパッケージを.NET Web APIプロジェクトにインストールします。

dotnet add package Hexarc.Pact.AspNetCore

Startup.ConfigureServicesメソッドに協定スキーマ生成を追加します。

 public void ConfigureServices ( IServiceCollection services )
{
    services . AddControllers ( ) ;

    // Register the Pact schema generation.
    services . AddPactGeneration ( ) ;
}

Startup.ConfigureメソッドでPACTミドルウェアを有効にします。

 public void Configure ( IApplicationBuilder app )
{
    // Enable the Pact middleware to expose the generated API schema.
    app . UsePact ( ) ;

    app . UseRouting ( ) ;
    app . UseEndpoints ( endpoints => endpoints . MapControllers ( ) ) ;
}

PACTアノテーションルールに従ってAPIコントローラーを実装してください。

 [ ApiController , Route ( "Misc" ) ]
public sealed class MiscController : ControllerBase
{
    [ HttpGet ( nameof ( Ping ) ) ]
    public String Ping ( [ FromQuery ] String message ) => $ "Hello, { message } " ;
}

アプリを起動して、 YOUR_API_HOST/pact/schemaアドレスを開き、PACT APIスキーマが生成されるようにします。

PACT APIスキーマを消費します

.NETプロジェクトにHexarc.Pact.Clientパッケージをインストールします。

dotnet add package Hexarc.Pact.Client

プロジェクトにHexarc.Pact.Toolツールをインストールします。

dotnet tool install Hexarc.Pact.Tool

Hexarc.Pact.Toolツールをインストールする前に、.NETツールマニフェストをセットアップする必要がある場合があります。

dotnet new tool-manifest

目的のAPIクライアントの生成設定を使用して、プロジェクトにpact.json構成を追加します。

{
   "schemaUri" : " YOUR_API_HOST/pact/schema " ,
   "clientClassName" : " DemoClient " ,
   "clientClassNamespace" : " DemoNamespace " ,
   "outputDirectory" : " Generated "
}

どこ

schemaUri協定APIスキーマへのリンク
clientClassName生成されたAPIクライアントクラスの名前
clientClassNamespace名前空間生成されたAPIクライアントクラスに入れる場所
outputDirectory生成されたソースの出力ディレクトリ

PACT CLIツールを介してAPIクライアントを生成します。

dotnet pact

このコマンドは、 pact.json configを使用して同じフォルダーで実行する必要があります。

生成されたAPIクライアントは、APIサーバーにアクセスできるようになります。

 var client = new DemoClient ( new HttpClient { BaseAddress = new Uri ( "YOUR_API_HOST" ) } ) ;
var pong = await client . Misc . Ping ( "World" ) ;
Console . WriteLine ( pong ) ; // Prints "Hello, World" to the output.