#json #swagger #openapi #mojolicious #jsonlines
Вопрос:
Есть ли способ описать json-строки с помощью OpenAPI?
Помимо того факта, что, похоже, для этого еще нет типа MIME, мне интересно, можно ли описать такой ответ.
Теоретически моим ответом мог быть массив объектов, но я получил вопрос, могу ли я передавать данные в виде json-строк, что означает: только объекты, по одному на строку.
Поскольку я использую OpenAPI для описания своего API, я озадачен тем, как описать этот ответ. Я мог бы просто определить ответ как тип «строка», но это не очень полезно для читателей моей спецификации API.
Комментарии:
1. Вы можете получить лучший ответ, опубликовав это в репозитории спецификации OpenAPI: github.com/OAI/OpenAPI-Specification/discussions
2. К сожалению, ответов там меньше, чем здесь…
3. Я подозреваю, что это было бы просто
type: stringпотому, что у него нет зарегистрированного типа MIME, и это не vanilla JSON. Но было бы неплохо получить подтверждение от сопровождающих OpenAPI.