Получить информацию о ожидаемом синтаксисе строки в теле запроса

Question

я был дан чванством API с телом запроса определяется как

{ 
    "SqlFilterList": "string", 
    "SubjectKey": 0, 
    "SubjectCwaListingKey": 0 
} 

программиста, который написал API находится в отпуске и не может быть достиг. У меня нет доступа к коду API. Существует ли вообще запрос на опрос api, чтобы определить, что могут быть действительными значениями «string»? Или мне нужно ждать, пока человек вернется в офис?

Я просмотрел документацию API по его URL-адресу (поэтому я знаю, что ему нужна строка), я искал Swagger website и искал вопросы с тегом [swagger] в stackoverflow и ничего не заметил.

Если ответ заключается в том, что мне не повезло (что я сильно подозреваю, что это правда), есть способ, которым я могу предложить автору документировать действительный синтаксис «строки» в API, следующий человек не проходит через это?

Answer 1

Похоже, вы нашли свой путь к Swagger-UI, отображая документацию по API и интерактивные кнопки «попробуйте».

Скорее всего, API просто не документирован так тщательно, как вам нужно. Но есть шанс, что вы сможете найти больше информации из спецификации Swagger. Несколько вещей, которые вы можете сделать, чтобы копать глубже:

Посмотрите на заказ модели

В Swagger-интерфейсе выберите вкладку «модель» в заголовке операции:

Будет отображаться дополнительная информация о структуре запроса, если разработчик предоставил описания уровня собственности. Введенная по умолчанию «схема схемы», которая отображается по умолчанию, действительно является автогенерированным примером структуры сообщений; не очень полезно, если вы ищете подробную документацию запроса.

Осмотрите чванство Источник

Вы можете быть в состоянии проверить спецификацию источника Swagger, что заполнение Swagger-интерфейс. Попробуйте использовать команду «view source» в вашем браузере и найдите конструктор объекта SwaggerUi. Это будет выглядеть примерно так:

var swaggerUi = new SwaggerUi({ 
    url: 'http://petstore.swagger.io/v2/swagger.json', 
    dom_id: 'swagger-ui-container' 
}); 

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

Обратите внимание, что существует другая форма конструктора SwaggerUi, которая не использует свойство url. Вместо этого он использует свойство spec, значение которого является (большим!) Объектом JSON. Вы можете скопировать-вставить этот объект в редактор Swagger или JSON (для упрощения чтения с автоматическим форматированием, раскраски синтаксиса и т. Д.) И посмотреть, есть ли там дополнительная информация.

Если ответ заключается в том, что мне не повезло (которое, как я подозреваю, является истинным), есть способ, которым я могу предложить автору документировать действительный синтаксис «строки» в API так что следующий человек не проходит через это?

Надеюсь, разработчик API предоставил канал обратной связи либо по электронной почте, либо по сайту поддержки. Там могут быть некоторые виджеты документации API, которые включают обратную связь или обсуждения напрямую, но Swagger-UI в это время не работает, AFAIK.