How to specify example on Swagger UI in .NET Core Web API?

Question

I want to specify an example of string input format on swagger for users information purpose.

what i wanted to do is to put an example below the property ColumnAndSortOrder like "for e.g. Resource, Asc"

Is it possible to do so in .NET Core ?

BTW I'm using swagger UI 3.0

Any help or pointers are welcomed.

Mahdi · Accepted Answer · 2022-07-24 12:01:17Z

1

you can use these two attributes :

    [System.ComponentModel.Description("some description")]

or

    [Swashbuckle.AspNetCore.Annotations("some description")]

on your apis or properties

answered Jul 24, 2022 at 12:01

Mahdi

1692 silver badges9 bronze badges

Sign up to request clarification or add additional context in comments.

1 Answer 1