Представить строку как перечисление с помощью NSwag

у меня есть этот контроллер

public class Person
{
   public int Id { get; set; }
   public string Position { get; set; }
}

[ApiController]
[Route("[controller]")]
public class MyCtrl : ControllerBase
{
   [HttpGet("{id}")]
   public ActionResult<Person> Get(int id)
   {
      // load person with ID == id from db
      return new ActionResult<Person>(person);
   }
}

Теперь Position — это просто строка, но в зависимости от конфигурации в базе данных это может быть только набор конечных значений. Мне бы очень хотелось, чтобы я мог имитировать то, что Position было перечислением в интерфейсе Swagger (я использую NSwag).

Мне бы хотелось, чтобы API выглядел так, как будто он был создан на основе этого (где PositionType генерируется из конфигурации в БД):

public enum PositionType
{
   Student,
   Teacher
}

public class Person
{
   public int Id { get; set; }
   public PositionType Position { get; set; }
}

Не уверен, что это полезно github.com/RicoSuter/NSwag/issues/3321 — проблема все еще открыта

— 21.03.2024 13:50

c# nswag

21.03.2024 13:35

Стоит ли изучать PHP в 2026-2027 годах?

Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...

Поведение ключевого слова "this" в стрелочной функции в сравнении с нормальной функцией

В JavaScript одним из самых запутанных понятий является поведение ключевого слова "this" в стрелочной и обычной функциях.

Приемы CSS-макетирования - floats и Flexbox

Здравствуйте, друзья-студенты! Готовы совершенствовать свои навыки веб-дизайна? Сегодня в нашем путешествии мы рассмотрим приемы CSS-верстки - в...

Тестирование функциональных ngrx-эффектов в Angular 16 с помощью Jest

В системе управления состояниями ngrx, совместимой с Angular 16, появились функциональные эффекты. Это здорово и делает код определенно легче для...

Концепция локализации и ее применение в приложениях React ⚡️

Локализация - это процесс адаптации приложения к различным языкам и культурным требованиям. Это позволяет пользователям получить опыт, соответствующий...

Пользовательский скаляр GraphQL

Листовые узлы системы типов GraphQL называются скалярами. Достигнув скалярного типа, невозможно спуститься дальше по иерархии типов. Скалярный тип...

137

Перейти к ответу Данный вопрос помечен как решенный

Ответы 1

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

В итоге я сделал это.

[AttributeUsage(AttributeTargets.Property)]
public class PositionEnum : Attribute
{
}

public class Person
{
   public int Id { get; set; }
   [PositionEnum]
   public string Position { get; set; }
}

public class PositionEnumProcessor : ISchemaProcessor
{
    public void Process(SchemaProcessorContext context)
    {
        var propertyInfos =
            context.ContextualType.Properties
                .Where(x => Attribute.IsDefined(x.PropertyInfo, typeof(PositionEnum)))
                .ToList();
        if (!propertyInfos.Any())
        {
            return;
        }
        var jsonSchema = context.Generator.Generate(typeof(PositionType), context.Resolver);
        var containerSchema = JsonSchema.FromType<object>();
        containerSchema.Type = JsonObjectType.None;
        containerSchema.Reference = jsonSchema;
        foreach (var propertyInfo in propertyInfos)
        {
            var camelCasePropertyName = System.Text.Json.JsonNamingPolicy.CamelCase.ConvertName(propertyInfo.Name);
            if (context.Schema.Properties.TryGetValue(camelCasePropertyName, out var schemaProperty))
            {
                schemaProperty.Type = JsonObjectType.None;
                schemaProperty.OneOf.Add(containerSchema);
            }

        }
    }
}

Затем в builder.Services.AddOpenApiDocument() я добавил это:

...
openApiConfiguration.SchemaSettings.SchemaProcessors.Add(new PositionEnumProcessor());
...

Если у кого-то есть более элегантное решение, дайте мне знать 😊

02.04.2024 14:16

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

Хотите написать метод FileUpload в WebAPI с использованием NSwag?

Как создать во время компиляции отдельный файл OpenAPI Swagger.json для каждого контроллера в моем проекте ASP.NET?

Вложенный массив объектов — item.toJSON не является функцией

NSwag генерирует несколько функций с одинаковым именем при использовании файла JSON OpenApi 3.0

Создайте клиент API для использования в vue

Пользовательское имя схемы в NSwag

Создайте один клиент кода / сгладьте контроллеры с помощью NSwag и AutoREST

Как загрузить пользовательскую таблицу стилей с помощью UseSwaggerUi3 от NSwag

Как добавить пользовательские заголовки в документ NSwag с помощью C# .NET CORE?

Как авторизовать Swagger для использования MS Graph API

Представить строку как перечисление с помощью NSwag

Ответы 1

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

Похожие вопросы