{"repo":"asyncapi/saunter","free":true,"listed":false,"github":"https://github.com/asyncapi/saunter","clone":"git clone https://github.com/asyncapi/saunter.git","description":"Saunter is a code-first AsyncAPI documentation generator for dotnet.","language":"C#","stars":227,"topics":["asyncapi","dotnet","aspnetcore","openapi","documentation","amqp"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"Saunter Saunter is an AsyncAPI documentation generator for dotnet. ℹ Note that pre version 1.0.0, the API is regarded as unstable and breaking changes may be introduced . Getting Started See examples/StreetlightsAPI. 1. Install the Saunter package 2. In the ConfigureServices method of Startup.cs , configure Saunter. 3. Add attributes to your classes which publish or subscribe to messages. 4. Add saunter middleware to host the AsyncApi json document. In the Configure method of Startup.cs : 5. Use the published AsyncApi document: 6. Use the published AsyncAPI UI: Configuration See the options source code for detailed info. Common options are below: Bindings Bindings are used to describe protocol specific information. These can be added to the AsyncAPI document and then applied to different components by setting the BindingsRef property in the relevant attributes [OperationAttribute] , [MessageAttribute] , [ChannelAttribute] Available bindings: https://www.nuget.org/packages/AsyncAPI.NET.Bindings/ Multiple AsyncAPI documents You can generate multiple AsyncAPI documents by using the ConfigureNamedAsyncApi extension method. Classes need to be decorated with the AsyncApiAttribute specifying the name of the AsyncAPI document. Each document can be accessed by specifying the name in the URL Migration to LEGO AsyncApi.Net When switching to the LEGO AsyncApi.Net, we broke the public API. To simplify the transition to new versions of the library, this note was created. What was broken: N","default_branch":null,"files":null,"tree":[],"storefront":"/r/asyncapi","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/asyncapi/saunter/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}