С# Генерация Swagger для перечисления со значением по умолчанию

У меня API выглядит следующим образом:

public Task<IActionResult> GetAsync([FromRoute] string id, [FromQuery] Query select = Query.All)

Для запросов мы хотим разрешить только определенные свойства, перечисленные в перечислении Query, как показано ниже:

    public enum Query
    {
        All,
        Property1,
        Property2
    }

я добавил

 services.AddSwaggerGen(c =>{c.DescribeAllEnumsAsStrings();})

в startup.cs, но это не работает для значения по умолчанию, я получаю следующее сгенерированное swagger, значение по умолчанию равно 0 вместо строки:

     {
        "name": "selec",
        "in": "query",
        "description": "",
        "required": false,
        "type": "string",
        "default": 0, //NOT SHOWN AS STRING
        "enum": [
          "none",
          "property1",
          "property2"
        ]
      },

Как сделать так, чтобы значение по умолчанию отображалось в виде строки?

Стоит ли изучать 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
1 488
1
Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

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

Ваш проект автоматически десериализуется в соответствии с настройками сериализации вашего приложения, обходной путь заключается в добавлении тега, который изменяет сериализацию этого конкретного свойства.

[JsonConverter(typeof(StringEnumConverter))]

Обновлено: при запуске вы можете ввести свои параметры json для сериализации перечислений в строки следующим образом:

 services.AddMvc().AddJsonOptions(options =>
                {
                    options.SerializerSettings.Converters.Add(new StringEnumConverter(true));
                });

куда добавить этот тег? Когда я смотрю на то, что генерирует SDK swagger, я вижу это там, но я не понимаю, как добавить его в код, чтобы он правильно сериализовался.

Ben Zifkin 03.12.2019 18:35

@BenZifkin этот подход находится прямо над вашим свойством класса, которое соответствует перечислению. для конфигурации запуска проверьте редактирование

Tiago Silva 04.12.2019 10:24

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