Создание пользовательских образцов на странице справки WebAPI? - PullRequest
Новая
       16

Создание пользовательских образцов на странице справки WebAPI?

0 голосов
/ 14 июля 2020

Я не очень хорошо знаком с тем, как работает справочная страница WebAPI ASP. Net. Я знаю, что могу создать документацию для своего WebAPI, и все остальное у меня в значительной степени работает. Однако я хотел бы настроить образцы формата запроса / ответа, потому что, хотя автоматически сгенерированные примеры полезны, они на самом деле не предоставляют рабочего примера из-за дополнительных проверок. Например, в моем случае в образце формата запроса у меня есть следующие 3 переменные (их больше, но они сосредоточены на них): 

{
  "CurrencyID": "sample string 1",
  "Email": "sample string 2",
  "WebAddress": "sample string 3"
}

Если я отправлю это методу, который вызываю, он ' Я верну ошибку, потому что максимальная длина CurrencyID равна 3, а в Email и WebAddress указаны форматы c, такие как «xyz@test.com» и «www.test.com» соответственно. Итак, я хотел бы указать это на моей странице справки и показать что-то вроде этого вместо ранее показанного примера: 

{
  "CurrencyID": "EUR",
  "Email": "xyz@test.com",
  "WebAddress": "www.test.com"
}

Возможно ли это вообще?

Заранее спасибо!

...