Web-API Swagger / Swashbuckle - связать поле с поиском в базе данных

Question

Как лучше всего, используя Swashbuckle, определить, что значение для определенного поля должно быть строкой из списка поиска в базе данных?

То, что я ищу, это какой-то способукрасить свойство модели, чтобы указать, что это перечисление, но фактически не объявлять тип как перечисление?

Список допустимых значений может содержать от 5 до 10 элементов.Однако они не могут быть определены как фактические перечисления в моем приложении, так как они доступны для редактирования через CMS и хранятся в таблице базы данных.

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

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

Answer 1

Я сделал что-то подобное с проверочным ключевым словом pattern:
https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3

Ваш swagger.json будет выглядеть так:

"Transparency": {
  "type": "string",
  "pattern": "^(high|medium|low)"
},

Для этого у вас естьдва варианта:

• В вашем коде C # вам нужно иметь

[RegularExpression("^(high|medium|low)")]
public string Transparency { get; set; }

• Или добавитьшаблон во время выполнения с использованием iDocumentFilter