dotnet-nats-template

KO | EN

gitlite — search

#javascript #react #typescript #golang #linux #docker #macos #java #nodejs #awesome #vue #security #ios #open-source

dotnet-nats-template

(★ 18)

.NET template for NATS

dotnet-nats-template Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">.NET C# NATS template</h1>

This is a .NET C# NATS template for the AsyncAPI generator

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](https://raw.githubusercontent.com/asyncapi-archived-repos/dotnet-nats-template/master/)

This template is for generating a .NET C# wrapper for the NATS client based on your AsyncAPI document. The template is based on the [nats.net](https://github.com/nats-io/nats.net) library.

Have you found a bug or have an idea for improvement? Feel free to contribute! See [the contribution guidelines](#Contributing) how to do so.

## Example usage
Given any AsyncAPI file (`AsyncAPI.yml`) first generate the client with the [AsyncAPI generator](https://github.com/asyncapi/generator) such as 
```bash
ag --install --output ./nats-client ./AsyncAPI.yml @asyncapi/dotnet-nats-template
```

# How to use
The generated output shall be seen a separate library (similar to any REST API client), that can be interacted with. It generates all the necessary functionality for you to easily interact with the NATS broker based on the AsyncAPI definition of the application.

## Requirements
* @asyncapi/generator < v2.0.0 >v1.1.1

Install the generator through [npm or run it from docker official installer](https://github.com/asyncapi/generator#install).

## Template configuration

You can configure this template by passing different parameters in the Generator CLI: `-p PARAM1_NAME=PARAM1_VALUE -p PARAM2_NAME=PARAM2_VALUE`

Name | Description | Required | Default | Allowed Values | Example
---|---|---|---|---|---
version | Version to use for the generated library. | No | `0.0.1` | string | `1.0.1`
projectName | Name of the generated library. | No | `AsyncapiNatsClient` | string | `MyCustomName`
repositoryUrl | Repository url for the project file, often needed for release pipelines. | No | None | string | `https://github.com/GamingAPI/rust-csharp-game-api.git`
targetFramework | Set the project target frameworks. Separate multiple by `;`. | No | `netstandard2.0;netstandard2.1` | string | `net461`
packageVersion | PackageVersion to use for the generated library. | No | None | string | `1.0.1`
assemblyVersion | AssemblyVersion to use for the generated library. | No | None | string | `1.0.1.0`
fileVersion | FileVersion to use for the generated library. | No | None | string | `1.0.1.0`
serializationLibrary | Serialization library for the underlying models. | No | `json` | `newtonsoft` or `json` (system.text.json)` | `newtonsoft`

# Contributing

Before contributing please read the [CONTRIBUTING](CONTRIBUTING.md) document.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<table>
 <tr>
 <td align="center"><a href="https://github.com/jonaslagoni"><img src="https://avatars.githubusercontent.com/u/13396189?v=4?s=100" width="100px;" alt=""/> Jonas Lagoni</a> <a href="https://github.com/asyncapi/dotnet-nats-template/commits?author=jonaslagoni" title="Code">💻</a> <a href="#maintenance-jonaslagoni" title="Maintenance">🚧</a> <a href="#question-jonaslagoni" title="Answering Questions">💬</a> <a href="#ideas-jonaslagoni" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/dotnet-nats-template/commits?author=jonaslagoni" title="Documentation">📖</a> <a href="https://github.com/asyncapi/dotnet-nats-template/issues?q=author%3Ajonaslagoni" title="Bug reports">🐛</a></td>
 <td align="center"><a href="https://dev.to/derberg"><img src="https://avatars.githubusercontent.com/u/6995927?v=4?s=100" width="100px;" alt=""/> Lukasz Gornicki</a> <a href="https://github.com/asyncapi/dotnet-nats-template/pulls?q=is%3Apr+reviewed-by%3Aderberg" title="Reviewed Pull Requests">👀</a></td>
 <td align="center"><a href="https://github.com/YoeriVD"><img src="https://avatars.githubusercontent.com/u/2865793?v=4?s=100" width="100px;" alt=""/> Yoeri Van Damme</a> <a href="https://github.com/asyncapi/dotnet-nats-template/commits?author=YoeriVD" title="Code">💻</a></td>
 </tr>
</table>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

dotnet-nats-template

dotnet-nats-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dotnet-nats-template

dotnet-nats-template Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README