Привет, коллеги!
Давайте поговорим о том, что действительно выматывает при работе с API — о документации.📝
Большинство проектов разрабатывается по принципу "code first". Обычно при таком подходе документацию создают уже в готовой системе, когда делать что-то еще особенно лень. Некоторые утверждают, что документацию вообще можно и не делать, и так всё понятно! Есть и плюсы - быстрое начало разработки и первые результаты, но минусы перевешивают.
🔤
Пока документация не готова, те, кто работает с вами над проектом, будут простаивать и ждать вас, или, что еще хуже, станут что-то писать самостоятельно, основываясь на своем опыте. Это неизбежно приведет к конфликтам (в том числе внутри команды). Также "code first" тянет за собой необходимость добавлять много аннотаций и атрибутов.
Решение. На курсе я покажу как делать удобнее: двигаться от спецификации, по подходу “specification first”. В этом случае у нас на проекте первым делом будут подготовлены: документация, коллекции Postman и возможность кодогенерации.
Крутое преимущество этого решения — фронтендеры (и все остальные) смогут работать одновременно с нами (бэкэндерами), а не ждать нас.
Ну а спецификацию писать можно научить хоть бухгалтершу!
Если вы хотите узнать больше и научиться эффективно работать с API, присоединяйтесь к нашему курсу. Это отличная возможность повысить свои навыки и избежать типичных проблем при разработке:
https://learn.cutcode.dev/store-api
Post #588
1.35K
- 👍 20
- ❤ 6
- 🥰 6
- 🎉 5
- 🤩 4
- 👏 3
- 🔥 2
- ❤🔥 1
- 💋 1