hexarc pact下載 - hexarc pact源代碼下載

hexarc pact

其他類別

1.0.0

下載

Hexarc Pact

HEXARC PACT提供了一個工具鏈，用於曝光和消費基於.NET/打字稿項目的Web API。

使用PACT開發.NET Web API項目，以保留API元數據的單個真實來源，並在.NET生態系統（微服務，桌面和移動應用程序）或Web上通過Tyxpycript消費。

包裹	平台	版本	下載
`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類型。

PACT類型系統內部是什麼：

原始類型（包括Guid和DateTime ）
價值/參考類型語義
收集和仿製藥（不僅簡單的數組和詞典）
完全支持無效的參考類型註釋（NRT）
枚舉（基於字符串的和基於數字）
標記的工會（通過hexarc.serialization.union）
元組（通過hexarc.serialization.tuple）

API註釋規則

PACT API模式設計為具有RPC樣語義。這樣一來，暴露的API必須遵循以下規則：

API控制器必須用標準的ApiController和Route屬性標記。
路由屬性必須只有一個恆定的字符串路徑而無需模板（例如[Route("Entities")] ）。
API方法必須用支持的HTTP動詞之一（ HttpGet或HttpPost ）標記。動詞屬性可能包含端點路徑。目前不支持其他人。
- HttpGet方法可以具有必須通過FromQuery屬性綁定的查詢參數。
- HttpPost方法必須只有一個參數，即請求主體。
可以在HTTP動詞屬性或Route屬性中指定API方法路徑。如果未在HTTP動詞屬性中指定方法路徑，則將從一號Route中取出或將提高例外。

其他屬性

PACT為API註釋提供了一些有用的屬性：

PactIgnoreAttribute可以應用於API控制器或用於從API模式中排除的方法。
PactScopeAttribute可以應用於API控制器，以分離為API模式中的特定範圍。

演示API服務器

可以在https://hexarc-demo-api.herokuapp.com/上找到演示API服務器。

PACT API模式在https://hexarc-demo-api.herokuapp.com/pact/schema上暴露。

要生成API客戶端，請使用以下指令。

如何使用

找出如何使用PACT暴露和消費典型的Web API。

暴露契約API模式

在.NET Web API項目中安裝Hexarc.Pact.AspNetCore軟件包：

dotnet add package Hexarc.Pact.AspNetCore

在Startup.ConfigureServices中添加PACT模式生成。 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架構。

消費協議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

在項目中添加pact.json配置，並具有所需的API客戶端生成設置：

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

在哪裡

schemaUri鏈接到PACT 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.