Щоб ідентифікувати ресурси в дизайні RESTful API, вам потрібно проаналізувати вимоги та цілі системи та зрозуміти домен і модель даних. Гарний спосіб почати — використовувати іменники для опису основних сутностей і понять, які мають відношення до системи, і згрупувати їх у логічні категорії або колекції.8 січня 2024 р.
REST API базується на використанні ресурсів—частини даних у Salesforce, такі як записи, колекції записів, результати запитів, метадані або інформація API. Кожен ресурс представлений уніфікованим ідентифікатором ресурсу (URI) і доступ до нього здійснюється шляхом надсилання HTTP-запитів до відповідного URI.
API REST дотримуються архітектури на основі ресурсів, де кожна частина даних або функціональність представлена як ресурс. Кожен ресурс ідентифікується унікальним URI (уніфікований ідентифікатор ресурсу), і клієнти можуть взаємодіяти з цими ресурсами за допомогою стандартних методів HTTP.
Використовуйте іменники, бажано у множині, для представлення ресурсів, що відповідає архітектурному стилю REST. Уникайте глибокого вкладення та непотрібних спеціальних символів у назвах кінцевих точок. Розділяйте слова дефісами та використовуйте малі літери, щоб уникнути плутанини. Не використовуйте розширення файлів в URI.
REST API принципово спирається на три основні елементи:
- Клієнт. Клієнт — це програмний код або програма, яка запитує ресурс із сервера.
- Сервер. Сервер — це програмний код або додаток, який керує ресурсом і відповідає на запити клієнта щодо ресурсу.
- Ресурс.
Ресурси в контексті API є дані або об’єкти, які API може надавати або якими може маніпулювати. Ресурси можуть бути матеріальними сутностями, як-от профілі користувачів, продукти або абстрактні поняття, як-от маркер автентифікації.
API — це набір правил і специфікацій, яким програмне забезпечення може дотримуватись, щоб спілкуватися одна з одною. Чотири найпоширеніші операції REST API: створювати, читати, оновлювати та видаляти (CRUD).