Обложка канала

Программирование {BookFlow}

17344 @bookflow

Программирование {BookFlow} Публикуют лекции и книги по программированию, видеоуроки, доклады с IT конференций.

Программирование {BookFlow}

3 года назад
Открыть в
Что не так с OpenAPI? Как мы боролись с документированием API на наших проектах, и как мы немного сошли с ума У вас на проекте порядок с документацией на API? Скорее всего нет. И в нашей компании порядка не было. Не будем рассказывать, к каким печальным последствиям приводит ошибочная, устаревшая или вовсе отсутствующая API-документация. Почему же на большинстве проектов не удаётся решить такой, казалось бы, несложный вопрос? Причина проста: разработчики терпеть не могут описывать API. Это неудобно, это мучительно, этого никогда не хочется делать. И даже если начальник однажды заставит (мольбами и угрозами) написать документацию на первую версию API, то в дальнейшем, когда API изменится, обновлять документацию на него разработчик уже точно не будет. Например, OpenAPI — самый распространённый язык описания REST API. Писать на этом языке настолько больно, что разработчик никогда не упустит шанс этого не делать (вот хороший пример отношения к OpenAPI). https://habr.com/ru/articles/732572/ 👉@Bookflow
Что не так с OpenAPI?

Как мы боролись с документированием API на наших проектах, и как мы немного сошли с ума У вас на проекте порядок с документацией на API? Скорее всего нет. И в нашей компании порядка не было. Не будем...

Хабр