(Организационный вопрос) Какие есть инструменты и техники разработки API?

Добрый день.

Есть 3 команды разработчиков - Бэк-энд, фронт-энд и мобильные разработчики. Бэк-энд пишет API для использования во фронте и мобильщиками. Проблема в том, что фронт и мобильщики не знают, какие end-points созданы, какие изменены, каких входных параметров они ожидают и какого вывода ожидать на выходе.

Какие есть инструменты, или паттерны (кроме человеческого общения, разумеется) для автоматизации, стандартизации и выработки некоего стайлгайда, дабы избежать ежедневных фейспалмов и излишних вопросов "Почему это перестало работать/работает не так как ожадается" и т п.?

Спасибо заранее за ответы.
  • Вопрос задан
  • 2454 просмотра
Пригласить эксперта
Ответы на вопрос 5
fox_12
@fox_12
Расставляю биты, управляю заряженными частицами
sergey-gornostaev
@sergey-gornostaev
Седой и строгий
API лучше проектировать и согласовывать до начала разработки.
Ответ написан
b0nn1e
@b0nn1e
Alcohol & Ruby on Rails
Для API использовал https://github.com/ruby-grape/grape (отлично встраивается в рельсы, можно использовать отдельно)
Гугл подсказывает https://github.com/ruby-grape/grape-swagger для документации(сам не использовал, не было проблемы с документированием)

Плюс минимальные тесты, по которым по желанию можно посмотреть что отдается, а что принимается.
Ответ написан
dmitry_pavlov
@dmitry_pavlov
World-class .NET freelance contractor (remotely)
Нужно описать API - какие будут endpoints, формат параметров и возвращаемых объектов (request/response).
В этом случае можно накидать API которые на начальной стадии будут возвращать dummy данные (заглушки с hardcoded данными). В этом случае фронтендеры будут иметь что-то для работы и смогут запросить изменения если что-то можно/нужно в API улучшить. Бекенжеры будут работать над своей частью, зная, к какому формату нужно привести данные и какие параметры у них будут на входе.

Поверх API (c фейковыми данными) можно сразу прикрутить какой-то API Explorer / Documentation тул вроде Swagger (для него есть порт на многие стеки разработки). Пример этого petstore.swagger.io

C таким или подобным тулом все всегда смогут зайти и посмотреть какой формат сейчас у API.
Ответ написан
lokki00003
@lokki00003
Web developer
:)
Писать все самому без бакэндов и фронтендов

Берешь то что тебе нужно и пишешь
Ответ написан
Ваш ответ на вопрос

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

Войти через центр авторизации
Похожие вопросы