API — как начать писать SDK для php MVC самостоятельно создан фреймворк
Я не знаю, как на самом деле задать свой вопрос, но вот он:
Мой начальник хотел, чтобы я создал простой MVC с PHP для нашего интернет-магазина.
Я сделал это (смотреть YouTube и …), это очень просто и легко сделать.
Теперь он продолжает просить меня:
Первый Создайте RESTful API (который использует curl).
второй Создайте хорошо документированный SDK!
Я много искал (правда), точно знаю, я могу понять, что делает API
но я не уверен, что такое SDK и как начать писать код
Может кто-нибудь дать мне пример кода, как начать писать?
Что он подразумевает под ** хорошо документированным **?
Я искал в Google, и я знаю, что буквально означают SDK и API, но моя проблема в том, что я не могу установить связь между моим MVC и API и SDK.
Как я могу начать писать API?
С чего мне начать?
В чем смысл ?
Может кто-нибудь привести пример?
Что должен делать мой SDK?
Я видел много видео об API, все они говорят об использовании REST, и REST очень хорош, и мы должны использовать GET / POST / DELETE / PUT и так далее и так далее.
но с чего мне начать?
РЕДАКТИРОВАТЬ
В моем случае, онлайн-шопинг, который просто просматривает нашу базу данных MongoDB и возвращает новые продукты и некоторые другие простые задачи, как мне использовать RESTful API? или СКД?
Спасибо и, пожалуйста, скажите мне, если объяснение не понятно.
Решение
Похоже, у тебя есть задача впереди.
Restful маршрутизация — это способ связи с сервером через стандартный HTTP protocols, Это такие вещи, как GET, POST, PUT, DELETE, так далее…
При спокойной маршрутизации вам не нужно вызывать неоднозначные методы для извлечения, обновления или удаления данных на сервере.
Например, когда вы пытаетесь получить пользователей с сервера, вы можете позвонить http://domain.tld/getAllUsers.php, Это не успокаивает.
Тем не менее, если вы получите всех пользователей, позвонив http://domain.tld/users/ и укажите, что вы хотите получить доступ к этому вызову через GET, который встроен в HTTP protocol, это будет restful,
Есть много ресурсов онлайн о том, чтобы узнать больше о restful routing,
APIs являются Application Programming Interafaces, Например, когда вы используете restful routing чтобы структурировать свое приложение, вы также реализуете APIпотому что вы даете другим способ получить доступ к данным на вашем сервере.
Однако все APIs не restful, На самом деле, многие не являются, и это сложнее для application programmers учиться, потому что они не следуют standard,
Было написано много книг о APIs и это больше, чем я могу охватить в этом ответе. Книга, которую я бы порекомендовал Build APIs You Won't Hate Фил Стерджен.
SDKs являются Software Development Kits и хотя большую часть времени они очень обширны, restful API что вы будете развивать, будет составлять SDK,
Впрочем, это может быть не тем, чего хочет ваш босс, это то, о чем вы должны спросить его.
Хорошо документированный код легко читается и понятен. Это потребует очень хорошего понимания языка, который использует ваша целевая аудитория.
Первым шагом в написании хорошей документации является написание хорошо прокомментированного кода. Хорошо прокомментированный код — лучшая документация, которую вы можете иметь, и после ее написания вы можете использовать такой инструмент, как PHPDoc создать документацию для вас. Это поколение может быть не таким обширным, как хотелось бы, а это означает, что вам нужно больше комментариев.
Прочитайте код от других разработчиков которые реализовали то, что вы ищете. Я склонен в этом случае, потому что это мой текущий выбор, но Laravel это PHP MVC framework это делает все это очень хорошо. Код также хорошо документирован и прост для понимания.
Кроме того, есть много хорошо написанных пакетов на Packagist это может помочь вам, вы должны проверить их и изучить Composer если вы еще этого не сделали
Если кто-то читает это, пожалуйста, исправьте меня.
Другие решения
Других решений пока нет …