Nano Hash - криптовалюты, майнинг, программирование

Параметры запроса Swashbuckle не работают при использовании привязки пользовательской модели

У меня конечная точка API ASP.NET Core 3.1 настроена следующим образом:

[HttpGet("api/controller/action/{id}")]
public async Task<IActionResult> GetSingle([FromRoute] GetSingleRequest request) {...}

DTO имеет единственное свойство Guid:

public class GetSingleRequest
{
  public Guid Id { get; set; }
}

Я настроил привязку пользовательской модели для привязки свойств Guid к строковым значениям, поскольку я использую короткую реализацию guid. Все это работает нормально при тестировании с помощью Postman.

Однако при использовании Swagger вместо передачи введенного параметра маршрута он передает шаблон параметра, например.

GET /api/controller/action/{id}     // Literally constructs the URI with {id}
GET /api/controller/action/abcd1234 // Not the value as entered

Я пробовал использовать MapType и ISchemaFilter следующим образом:

// startup.cs
c.MapType<Guid>(() => new OpenApiSchema {Type = "string", Format = null});
// startup.cs
c.SchemaFilter<GuidSchemaFilter>();

// GuidSchemaFilter.cs
internal class GuidSchemaFilter : ISchemaFilter
  {
    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
    {
      if (context.Type != typeof(Guid))
      {
        return;
      }

      schema.Type = "string";
      schema.Format = null;
    }
  }

Ни один из этих подходов не меняет этого странного поведения.

Как я могу настроить Swagger для передачи строки вместо Guid как части URI, когда у меня настроено настраиваемое связыватель модели?


Ответы:


1

Как я могу настроить Swagger для передачи строки вместо Guid как части URI, когда у меня настроено настраиваемое связыватель модели?

На самом деле c.MapType<Guid>(() => new OpenApiSchema {Type = "string", Format = null}); этого предложения достаточно, чтобы решить проблему.

Ключ к проблеме заключается в том, что параметры в вашем маршруте - это Camel Case: id, а поле в GetSingleRequest - это Pascal Case: Id.

В качестве комментария вы можете добавить c.DescribeAllParametersInCamelCase();, чтобы он игнорировал проблему с регистром.

  services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API" });
                c.MapType<Guid>(() => new OpenApiSchema { Type = "string", Format = null });
                c.DescribeAllParametersInCamelCase();
            }); 

Или вы измените идентификатор в шаблоне маршрута на идентификатор.

        [HttpGet("api/controller/action/{Id}")]
        public async Task<IActionResult> GetSingle([FromRoute] GetSingleRequest request) 
        {

            return Ok();
        }

Вот результат теста:

введите описание изображения здесь

14.08.2020
Новые материалы

Кластеризация: более глубокий взгляд
Кластеризация — это метод обучения без учителя, в котором мы пытаемся найти группы в наборе данных на основе некоторых известных или неизвестных свойств, которые могут существовать. Независимо от..

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

Частный метод Python: улучшение инкапсуляции и безопасности
Введение Python — универсальный и мощный язык программирования, известный своей простотой и удобством использования. Одной из ключевых особенностей, отличающих Python от других языков, является..

Как я автоматизирую тестирование с помощью Jest
Шутка для победы, когда дело касается автоматизации тестирования Одной очень важной частью разработки программного обеспечения является автоматизация тестирования, поскольку она создает..

Работа с векторными символическими архитектурами, часть 4 (искусственный интеллект)
Hyperseed: неконтролируемое обучение с векторными символическими архитектурами (arXiv) Автор: Евгений Осипов , Сачин Кахавала , Диланта Хапутантри , Тимал Кемпития , Дасвин Де Сильва ,..

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

Обеспечение масштабируемости LLM: облачный анализ с помощью AWS Fargate и Copilot
В динамичной области искусственного интеллекта все большее распространение получают модели больших языков (LLM). Они жизненно важны для различных приложений, таких как интеллектуальные..