Swagger показывает десятичное число как 0,00 вместо 0

У меня есть этот класс:

public class CostDto
{
    public int Id{ get; set; }
    public decimal? Price { get; set; }
}

В чванстве это показывает это:

{
    "Id": 0,
    "Price": 0
}

И я бы предпочел это:

{
    "Id": 0,
    "Price": 0.00
}

Это более четко укажет пользователю, что возвращаемое значение Price имеет десятичный, а не целочисленный тип. Возможно ли это вообще в чванстве? Я нашел несколько сообщений, относящихся к чему-то подобному, но, похоже, это не работает:

services.AddSwaggerGen(options =>
{
    options.MapType<decimal>(() => new OpenApiSchema { Type = "number", Format = "decimal" });
    options.MapType<decimal?>(() => new OpenApiSchema { Type = "number", Format = "decimal", Nullable = true });
});
Стоит ли изучать PHP в 2023-2024 годах?
Стоит ли изучать PHP в 2023-2024 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией
В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.
Приемы CSS-макетирования - floats и Flexbox
Приемы CSS-макетирования - floats и Flexbox
Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...
Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest
В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...
Концепция локализации и ее применение в приложениях React ⚡️
Концепция локализации и ее применение в приложениях React ⚡️
Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...
Пользовательский скаляр GraphQL
Пользовательский скаляр GraphQL
Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...
3
0
69
2
Перейти к ответу Данный вопрос помечен как решенный

Ответы 2

Ответ принят как подходящий

Вы можете попробовать это:

public class DecimalSchemaFilter : ISchemaFilter
{
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
        if (schema.Type == "number" && schema.Format == "decimal")
        {
            schema.Example = OpenApiAnyFactory.CreateFromJson("0.01");
        }
    }
}

services.AddSwaggerGen(options =>
{
    options.SchemaFilter<DecimalSchemaFilter>();

    options.MapType<decimal>(() => new OpenApiSchema { Type = "number", Format = "decimal" });
    options.MapType<decimal?>(() => new OpenApiSchema { Type = "number", Format = "decimal", Nullable = true });
});

Спасибо! Это сработало, за исключением того, что мне пришлось использовать «schema.Example = OpenApiAnyFactory.CreateFromJson(»0.01»);» потому что «CreateFor» устарел, а 0,00 всегда сокращается до 0. Может быть, вы можете добавить это в свой ответ? Я использую Swashbuckle 6.6.1.

J Flex 26.06.2024 15:29

Отлично, добавлю.

decius 26.06.2024 15:36

Пользовательский интерфейс Swagger удаляет нулевую десятичную часть чисел с плавающей запятой в отображаемых примерах. Это известное поведение: https://github.com/swagger-api/swagger-ui/issues/7337

В качестве обходного пути вы можете указать собственное значение example с ненулевой десятичной частью:

public class CostDto
{
    public int Id{ get; set; }

    /// <example>12.34</example>
    public decimal? Price { get; set; }
}

Другие вопросы по теме