@Capito

Как документировать поля форм (в т.ч. валидацию, логику), api, БД?

Здравствуйте,

Начали разработку web-приложения (SPA) в сегменте enterprise. Приложение содержит кучу форм, гридов и т.п. Все эти поля связаны кучерявой логикой.
На сейчас, поля описаны в excel, API описано в Api-blueprint формате в .md файлах. БД вообще ни как не описана, но понятно, что можно сделать реверс ижениринг и посмотреть связи.

Подскажите, есть ли какой-либо софт или методология, best practices, как документируются поля форм, апи, поля БД и что бы это было все в одном месте и ссылалось друг на друга. Напр. по полу в БД найти поле в API и/или поле в форме и обратно. Опять же, четкого сопоставление нет, могут быть поля api без полей формы и поля в БД, как и обратное, т.о.
может быть, что поле в форме != поле в апи != поле в бд.
Пробовал писать просто текстом (таблицами) в ТЗ, ну, какая-то каша получается, в разных местах все это. Тяжело поддерживать, напр. когда меняется название в форме, нужно найти не забыть и найти соотв. поля в БД, АПИ и поменять их.
С описанием валидации и логики тоже, как-то все размазано получается. Возможно руки растут так :) но надеюсь, что решения есть, просто я о них не знаю.

Спасибо.
  • Вопрос задан
  • 199 просмотров
Пригласить эксперта
Ответы на вопрос 3
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через TM ID
Похожие вопросы
Вакансии с Моего Круга Все вакансии
Заказы с Фрилансим Все заказы