Наша команда приступает к реализации событийно-ориентированных дизайнов. Сейчас мы выясняем, какие инструменты и методы лучше всего подходят для документирования схемы этих событий.
Какие общие инструменты используются для этого варианта использования?
Любые ссылки или предложения приветствуются.
Я бы начал с общей спецификации CloudEvents и моделировал свои события на ее основе, т. е. определял события как подтипы общей модели CloudEvent. Преимуществом здесь является совместимость с другими системами, основанными на той же спецификации, а также с существующими инструментами, такими как языковые SDK.
Что касается документации, я бы выбрал JSONSchema: вот определение JSONSchema например, для общего CloudEvent.
В качестве альтернативы есть спецификация AsyncAPI, которую можно использовать вместо CloudEvents или вместе с ним: прочитайте здесь о том, как они связаны.
