Хочу сделать API, с чего начать?

Question

[driverx18]

Хочу сделать рест апи (php + mysql), опыта в создании апи вообще нет. Допустим есть мобилка, какая будет общаться с сервером через апи, и стоит цель сделать хорошее, рест апи.
Вопросы следующие:
1) стоит ли делать апи с помощью какого то фреймворка, или с нуля?
2) надо выделять отдельный сервер для апи, или просто папочку в проекте назвать api, и туда все файлы связанные с ним положить?
3) хорошие примеры, литература, кто что может посоветовать. Когда ввожу rest api php выдаются пару уроков, но это не совсем то, что мне надо) нужны бест практис различные

Comments

[Алексей Макареня]

Для начала хотелось бы уточнить пару вопросов:
- а что у вас сейчас есть - у вас есть сайт, или может быть мобильное приложение?
- а на каком языке вы собираетесь писать api?
- а для чего вы пишете api и кто его собирается использовать?

Answer 1

[Philipp]

Следует начать с проектирования API. Возмите https://swagger.io/ и набросайте все, что нужно.
Swagger вам позволяет объединить роутинг, документацию и примеры вызовов в единое целое.
Кроме этого он позволяет сгенерировать заглушки для разных языков программирования и фреймворков.
В принципе вы можете найти значительное количество интеграций для разных фреймоворков.

В целом API лучше делать с помощью фреймворков, поскольку в них уже реализованы тривиальные моменты по безопасности, аутентификации и авторизации. Вы можете использовать микрофреймворки, например тот же Slim. Вы даже можете сгенерировать роутинг для него используя генератор от Swagger.

В REST есть 6 принципов, прекрасно изложенных в Wiki. В REST нет ничего сложного и особенного. Это просто надстройка над стандартным протоколом HTTP. Именно поэтому нет никаких особенных уроков. Изучите работу HTTP и вы поймете как работает веб в целом и REST в частности.

По поводу отдельного сервера для API. Есть множество разных подходов. В последнее время все более актуальными становятся Serverless-приложения. Serverless архитектура идеально вписывается в REST. Но думаю для вас это пока рановато и сложновато. Слишком много для начала.

Логичнее всего держать проект в моно-репозитарии, если он не будет большим. Если вы точно не знаете насколько большим он будет, то можно разбить проект на компоненты и использовать Composer для управления зависимостями (советую полность прочитать эту страницу от корки до корки).

По поводу best practices есть очень хороший ресурс https://12factor.net/ru/
Он в целом применяется для всех приложений.

Запомните: первый блин всегда комом. Прочитайте все ресурсы, которые я привел для вас. В них много ссылок на другие, походите по ним, присмотритесь. Напишите первую версию API так, как вам кажется удобно. Постарайтесь применить практики из статей.
Вам нужен опыт и вы его не наберетесь, пока не сделаете что-то сами. Вы можете потратить год на чтение, но останетесь на том же месте, с которого начали. А другой человек напишет на коленке API за неделю, а потом перепишет его 20 раз за год и он вам расскажет в 10 раз больше, чем то, что вы изучили за год.
Дерзайте!

Comments

[Семён Семёнов]

Свагер не красивый :)

[Станислав]

Семён Семёнов, а что тогда красивое?

[Семён Семёнов]

Станислав, https://paw.cloud

[Станислав]

Семён Семёнов, клево выглядит, но он же для Mac только?

[hOtRush]

Семён Семёнов, это тот же postman, только для мака и за 50 баксов?

[GTRxShock]

просто к свагеру надо добавить https://github.com/Rebilly/ReDoc

[hackuun]

Совершенно бредовый и вредный совет для человека который делает API впервые и мало имеет представления что это.

[hackuun]

Семён Семёнов, при чем тут paw? Я охреневаю с советов)))

[hackuun]

hOtRush, спрашивается, при чем тут сваггер вообще?)))

[hOtRush]

hackuun, ты спрашиваешь причем сваггер к рест апи? Знаешь, как начинающим дают рисовать блок схемы алгоритмов или диаграммы баз данных, так и построение апи можно начать с его проектирования.

[hOtRush]

hackuun, у paw есть экспорт в openapi/swagger формат

[DevMan]

hOtRush, только все таки лапка предназначена в первую очередь для теста.

она офигенна, но описывать в ней апи - идея так себе.

[Семён Семёнов]

hOtRush, Какая разница сколько стоит и чего - я говорю, просто красиво. А дальше - кому что нравится. Я готов заплатить - покупаю. Вы не готовы - идёте в опенсорс.

[hOtRush]

DevMan, я вообще не предлагал ее, посмотрите ветку)

[DevMan]

hOtRush, упс, Акелла промахнулся))

[DevMan]

hOtRush, сори.

Answer 2

[nozzy]

https://lumen.laravel.com/

Comments

[driverx18]

А если проект не на ларавел, а на другом фреймворке?

[nozzy]

Это не имеет значения.

[driverx18]

nozzy, обращаться к моделям фреймворка Yii2 чтоб взять данные, как я буду? Разве не на синтаксисе ларавел? В люмен вшит eloquent

[driverx18]

т.е. Вопрос, как из ларавелского фреймворка я буду обращаться к моделям другого фреймворка, и является ли это гуд практис?

[nozzy]

Вопрос, как из ларавелского фреймворка я буду обращаться к моделям другого фреймворка, и является ли это гуд практис?

Как вы себе это представляете?
А что на yii нельзя сделать rest api?

[German Jet]

driverx18, в Yii2 api идет из коробки, устанавливать ничего не надо, просто наследуешь контроллер от ActiveController и все

Answer 3

[sdfsdfertdfd]

Не надо изобретать велосипеды.
Юзай готовые кейсы - бест практис.

Надо обязательно оскорбить каждого начинающего изобретателя.
Рано тебе еще изобретать апи - сначала чужими пользуйся и не высовывайся, шибко умный нашелся тут.

Инициатива строго наказуема.
Все должны быть стандартными и заменяемыми - в этом сакральный смысл индустрии.

Comments

[Николай Панаитов]

Неправильно говорить что велосипед изобретается. Нафига тогда существует десятки разных подходов к реализации API, почему люди делает что-то новое, а не юзают готовое API, которое придумали в прошлом столетии? Мб потому что каждый видит по своему архитектуру своего приложения и далеко не все решения легко реализовать в готовый API, а на своем ты делает, то что необходимо для приложения, если вдруг кому-то понравится твой подход, его начнут часто применять где-то и глядишь догонит другие API реализации. Никто не знает что будет завтра, потому завтра твой API могут юзать миллионы людей!

[Andrej_I]

С этими словами один старый изобретатель схватился за вилы и полетел на один их первых тракторов, ибо учуял дым, когда подгорело и далеко не у трактора)

Answer 4

[Андрей К]

Судя по Вашему вопросу, Вам ещё далеко до создания API, если цель коммерческая, лучше обратиться к профессионалам.

Если для себя, то конечно нужно для начала освоить какой-то фреймворк, при чем, любой из основных предложит не плохое решение для API.

" надо выделять отдельный сервер для апи, или просто папочку в проекте назвать api, и туда все файлы связанные с ним положить?"... Вот честно, ещё рано, паттерн Фронт Контроллер в крови у каждого веб девелопера.

Comments

[hackuun]

Чушь полная. АПИ в разы проще чем создание современного фронта.

[Андрей К]

hackuun, а что я писал про фронт?

[Andrey]

Не отвечаешь на вопрос, лучше не пиши ничего. Человек ответы ищет а не - "Вам ещё далеко до создания API"

Answer 5

[Dmi3ii]

Я - новичок, но делал на laravel (на вырост). Для моих задач не сложно было, довольно быстро "въехал" в базу. В сети полно турториалов и видео по этой теме. Установите Insomnia или Postman, чтоб запросики посылать и тестируйте свой api.

Answer 6

[ThunderCat]

Вроде сегодня все основные фреймворки имеют апи интерфейсы? Или я что-то упускаю? имхо взять готовый отлаженный двиг и на нем быстро и аккуратно поднять апи - бест практис.

Answer 7

[Владимир Коротенко]

API
Application Programming Interface
Из этого следует что это какое то подобие общения с программой, которое описано в RTFM .
И если у вас не хватило терпения прочитать, заплатите деньги