cai.analyzers 0.21.1

About

This has analyzer for CAI apis

Steps

• Create a new asp.net web api project

• Add HotChocolate.AspNetCore > 14.2.0, HotChocolate.Data >= 14.2.0, Wolverine > 3.4.0 and Cai.Abstraction

• Setup HotChocolate and Wolverine as needed. Two helper functions have been provided - builder.addCai(...) and app.useCai(...)

• Apply the attributes Rest, Query and Mutation as needed.

• Apply RemoteHandler or Distributed to use Nats as the message broker in addition to Wolverine.

• Apply AutoLog to log all requests.

• Nats.Net#2.5.5 required

Known Issues

Due to a limitation with HotChocolate, ensure that there is at least 1 query for graphql to work.

Usage

Add the package with the following properties to cai.analyzers: OutputItemType="Analyzer" ReferenceOutputAssembly="false"

Breaking Changes

v0.20.0 is a breaking change.

• Nats.Net v2.5.5 required
• OpenTelemetry is required

Sample packages

  <ItemGroup>
    <PackageReference Include="HotChocolate.AspNetCore" Version="14.2.0" />
    <PackageReference Include="HotChocolate.Data" Version="14.2.0" />
    <PackageReference Include="NATS.Net" Version="2.5.5" />
    <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.10.0" />
    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.10.0" />
    <PackageReference Include="OpenTelemetry.Exporter.Prometheus.AspNetCore" Version="1.7.0-rc.1" />
    <PackageReference Include="OpenTelemetry.Extensions.Hosting" Version="1.10.0" />
    <PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.10.1" />
    <PackageReference Include="OpenTelemetry.Instrumentation.EntityFrameworkCore" Version="1.10.0-beta.1" />
    <PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.10.0" />
    <PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.10.0" />
    <PackageReference Include="OpenTelemetry.Instrumentation.SqlClient" Version="1.10.0-beta.1" />
    <PackageReference Include="Ulid" Version="1.3.4" />
    <PackageReference Include="WolverineFx" Version="3.4.0" />
  </ItemGroup>

Require configuration in app.config

Add the configuration below to your app.config. This is required by

  "otel": {
    "serviceName": "[change me]",
    "activitySourceName": "[change me]",
    "logs": [
      {
        "url": "http://localhost:4317",
        "protocol": "Grpc"
      },
      {
        "url": "console"
      }
    ],
    "traces": [
      {
        "url": "http://localhost:4317",
        "protocol": "Grpc"
      },
      {
        "url": "console"
      }
    ],
    "metrics": [
      {
        "url": "http://localhost:4317",
        "protocol": "Grpc"
      },
      {
        "url": "console"
      }
    ],
    "tags": [
      {
        "name": "app.name",
        "value": "[change me]"
      },
      {
        "name": "app.version",
        "value": "[change me]"
      }
    ]
  },
  "nats": {
    "url": "nats://127.0.0.1:4222",
    "username": "u",
    "password": "p",
    "services": {
      "defaultNamespace": "DefaultNamespace"
    }