hexarc pact下载 - hexarc pact源代码下载

hexarc pact

其他类别

1.0.0

下载

Hexarc Pact

HEXARC PACT提供了一个工具链，用于曝光和消费基于.NET/打字稿项目的Web API。

通过PACT开发.NET Web API项目，以保留API元数据的单一真实来源，并在.NET生态系统（微服务，桌面和移动应用程序）或Web上通过Tyspecript消费。

包裹	平台	版本	下载
`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.