Masswagger 1.5.0

Masswagger

Description

This package adds to your website/webapi a Swagger-like UI for MassTransit.

With Masswagger you can view and test your consumers easily and quickly.

Installation

Install the package:

dotnet add package Masswagger --version 1.5.0

And Masswagger services to your DI:

services.AddMasswagger();

And Masswagger middleware to your DI:

app.UseMasswagger();

Note: If your project using the UseEndpoints(), UseAuthenticationMiddleware() middleware, move the app.UseMasswagger(); under it.

Usage

Run the project and browser to the url /masswagger.

More Options

Display Types Documentation

You can display the Summary of the consumers and the message types by adding GenerateDocumentationFile to your .csproj file:

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <GenerateDocumentationFile>True</GenerateDocumentationFile>
  </PropertyGroup>

Result:

TestValue Attribute

To use TestValue attribute you need to install the Masswagger.Attributes package.

By using the TestValue attribute you can have default test value in message type:

    public class PublishNewsReport
    {
        [TestValue("test value from TestValueAttribute")]
        public string? Description { get; set; }
    }

If given multiple values the test value will be picked randomly:

    public class PublishNewsReport
    {
        [TestValue("test value1", "test value2")]
        public string? Description { get; set; }
    }

Multiple values also can use to set the test value for Array/List property:

    public class PublishNewsReport
    {
        [TestValue("value1", "value2", "value3")]
        public List<string> Descriptions { get; set; }
    }