Как документировать схему данных в Redis?

Question

[Сергей Соколов]

Как принято документировать схему данных Redis?
Формат имен ключей, типы, время жизни, назначение.
Чтобы другим разработчикам было понятно.

Например, для описания API очень понравился Swagger/OpenAPI.

Answer 1

[Илья]

У нас общая библиотека расшарена с типами и методами работы с Redis. Всё формирование ключей там же. Хранится json или бинарные данные сериализованные с помощью protobuf.
Подходит если все пишут на одном языке.

Answer 2

[Папа Стифлера]

Как вы собираетесь документировать то, чего нет? Redis - это key-value database, в ней нет схем данных. И ключи, и значения - строковые.

Comments

[Сергей Соколов]

Как разные компоненты приложения "договорились" обмениваться данными через Redis.
Фронт, бэк, рабочие.

[Сергей Соколов]

Кстати, Redis это больше, чем просто key-value. Поинтересуйтесь:
https://redis.io/topics/data-types-intro

[Папа Стифлера]

Сергей Соколов, мне не нужно интересоваться. Я даже знаю как он устроен внутри. По вашей ссылке написано ровно то-же самое. Везде только строки.

Как устроено ваше приложение - к Редису отношения не имеет и вы вольны документировать как заблагорассудится.

[Сергей Соколов]

вы вольны документировать как заблагорассудится

API тоже можно «документировать» на коробке из-под пиццы в единственном экземпляре, следуя такой логике. Да, можно. Но среди best practice – тот же swagger.

Папа Стифлера, спрошу иначе. В ваших проектах с участием нескольких разработчиков, как вы сообщали команде, которая проект видит впервые, какие данные в каком формате им ожидать из Redis'а?
Что в ключах с префиксомjobs:production:{uuid} хранятся не строки, а хэши. Что среди ключей хэша точно есть такие-то, а другие опциональны.

[Папа Стифлера]

Сергей Соколов, в чем проблема сопроводить код документацией? Безотносительно того, что под "капотом" - Редис или Кассандра? Кому непонятно - посмотрит в код. Не хотите давать код - сами напишите клиента для API и выложите как библиотеку.

PS: в моих проектах Редис не используется от слова совсем.

[Сергей Соколов]

Папа Стифлера, спасибо, что ответили.