АГ
а для чего тогда спека? я думал она описывает структуры данных для обмена между разными модулями / сервисами
Size: a a a
2021 February 09
k
а для чего тогда спека? я думал она описывает структуры данных для обмена между разными модулями / сервисами
для фронта
BT
халп
простой (ХЗ, на самом деле не очень) вопрос. Стоит ли держать спеку (напр. OAS) в отдельной от эндпоинтов, которые она описывает, репе?
Ну тип если рассмотреть монорепо-проект - часто всю спеку полностью кладут в отдельную папку. У нас проблема в том, что хотят запихнуть спеку по всем эндпоинтам (которые в разных репах) в одну общую репу документации.
Мне кажется, что с точки зрения кохижена и каплинга лучше всего пихать спеку к тому модулю, который спека описывает, это упростит изменения(не надо делать коммит в 2 репозитория по 1 фиче), удобнее будет подключать валидацию по json-schema.
Кто как делает?
простой (ХЗ, на самом деле не очень) вопрос. Стоит ли держать спеку (напр. OAS) в отдельной от эндпоинтов, которые она описывает, репе?
Ну тип если рассмотреть монорепо-проект - часто всю спеку полностью кладут в отдельную папку. У нас проблема в том, что хотят запихнуть спеку по всем эндпоинтам (которые в разных репах) в одну общую репу документации.
Мне кажется, что с точки зрения кохижена и каплинга лучше всего пихать спеку к тому модулю, который спека описывает, это упростит изменения(не надо делать коммит в 2 репозитория по 1 фиче), удобнее будет подключать валидацию по json-schema.
Кто как делает?
класть рядом удобно, но если захочешь цельную - то надо будет клеить
k
класть рядом удобно, но если захочешь цельную - то надо будет клеить
усложнение инфраструктуры - это да =\
я бы конечно решал эту проблему, но чёт люди хотят "побыстрее", как обычно
я бы конечно решал эту проблему, но чёт люди хотят "побыстрее", как обычно
k
с другой стороны шо вы хотели, если полезли "микросервисы" делать
КГ
с другой стороны шо вы хотели, если полезли "микросервисы" делать
Беги
k
побежать я всегда успею)
да и я в целом не работаю на этом проекте
скорее накидываю им на вентилятор.
Так сказать сторонний диванный консультант
да и я в целом не работаю на этом проекте
скорее накидываю им на вентилятор.
Так сказать сторонний диванный консультант
k
просто не шарю насколько это приемлемый компромисс
КГ
Я бы спеку из кода генерил.
Эти отдельно лежащие, которые руками синкать, нафиг надо
Эти отдельно лежащие, которые руками синкать, нафиг надо
КГ
У меня есть консольная команда, которая генерит документацию в markdown формате.
В Dockefile после шага где билдится прод php образ, идёт шаг где вызывается эта консольная команда и в файлик дампается дока. Следующим шагом идёт Slate, копирует из предыдщуего шага markdown и генерит html. После чего шаг с nginx, который html к себе копирует)
Я бы что-то такое же сделал, то есть код генерит спеку и она в виде файлика отдаётся nginx'ом
В Dockefile после шага где билдится прод php образ, идёт шаг где вызывается эта консольная команда и в файлик дампается дока. Следующим шагом идёт Slate, копирует из предыдщуего шага markdown и генерит html. После чего шаг с nginx, который html к себе копирует)
Я бы что-то такое же сделал, то есть код генерит спеку и она в виде файлика отдаётся nginx'ом
k
Я бы спеку из кода генерил.
Эти отдельно лежащие, которые руками синкать, нафиг надо
Эти отдельно лежащие, которые руками синкать, нафиг надо
это по сути вариация держать спеку в модуле, который спека описывает
КГ
это по сути вариация держать спеку в модуле, который спека описывает
Ну ключевой поинт в том, чтобы не было ручного синка. Ибо это боль. Положить спеку в модуль и тут же её руками синкать, не особо легче станет
k
Ну ключевой поинт в том, чтобы не было ручного синка. Ибо это боль. Положить спеку в модуль и тут же её руками синкать, не особо легче станет
просто ест другой вариант spec-first и генерить структуры из спеки, тогда руками синкать не надо
КГ
просто ест другой вариант spec-first и генерить структуры из спеки, тогда руками синкать не надо
подход есть, но я такое не встречал. Обычно спека на коленке по кд меняется
k
это просто разные проблемы. Проблема апдейта кода под спеку и проблема куда положить спеку, а куда код
КГ
это просто разные проблемы. Проблема апдейта кода под спеку и проблема куда положить спеку, а куда код
В ситуации когда спека появляется раньше кода, я бы наверное положил её отдельно, а когда код догнал спеку, то уже генерил её из кода
k
В ситуации когда спека появляется раньше кода, я бы наверное положил её отдельно, а когда код догнал спеку, то уже генерил её из кода
почему?
КГ
что почему?
k
почему в ситуации, когда спека появляется раньше кода, ты бы положил её отдельно?
КГ
а. Да хз. В ряде ситуаций так может быть удобнее. Типа тем кому нужна спека могут не иметь доступа к коду апи