Вчера согласовали вместе с командой переход с yaml на json для нашей конфигурации OpenAPI 🎉
Предварительно, ничего радикального против применения спецификации на yaml не имею (имеет место применяться и восхваляться адептами).
Почему JSON ?
- хотя себя я спрашиваю почему не YAML ?
1) проблематичная поддержка в IDE idea intellij для yaml - то есть она как бы есть и она как бы работает, при наличии n плагинов, но случаются затыки и сбои, временами не очевидные, на разбор которых уходит катастрофически много времени.
2) сумашедший стектрейс ошибок при кодогенерации на основе yaml, не возможность сразу установить причину сбоя без подробного изучения предмета ошибки . Шаг влево-вправо , лишний пробел и трейс меняется + разночтения при отрисовке UI openapi -> описание UI restapi отрисовывается согласно содержимому однако классы не генерируются.
3) сумасшедшая привязка к пробелам (отсутствие фигурных скобок) в yaml. Необходимость структурирования близкой к педантичной, большая привязка визуального и содержимого
Подводя итог, все увы сводится к вкусовщине и да проблемные вопросы можно решить, но раз мы в работе используем язык с фигурными скобками (в отличии от питоныча) и в качестве привычного формата данных используем Json , то почему бы и спецификацию не писать в том же ключе.
Друзья, было бы интересно услышать ваше мнение на этот вопрос 🍳
Предварительно, ничего радикального против применения спецификации на yaml не имею (имеет место применяться и восхваляться адептами).
Почему JSON ?
- хотя себя я спрашиваю почему не YAML ?
1) проблематичная поддержка в IDE idea intellij для yaml - то есть она как бы есть и она как бы работает, при наличии n плагинов, но случаются затыки и сбои, временами не очевидные, на разбор которых уходит катастрофически много времени.
2) сумашедший стектрейс ошибок при кодогенерации на основе yaml, не возможность сразу установить причину сбоя без подробного изучения предмета ошибки . Шаг влево-вправо , лишний пробел и трейс меняется + разночтения при отрисовке UI openapi -> описание UI restapi отрисовывается согласно содержимому однако классы не генерируются.
3) сумасшедшая привязка к пробелам (отсутствие фигурных скобок) в yaml. Необходимость структурирования близкой к педантичной, большая привязка визуального и содержимого
Подводя итог, все увы сводится к вкусовщине и да проблемные вопросы можно решить, но раз мы в работе используем язык с фигурными скобками (в отличии от питоныча) и в качестве привычного формата данных используем Json , то почему бы и спецификацию не писать в том же ключе.
Друзья, было бы интересно услышать ваше мнение на этот вопрос 🍳