Параметри шляху – це змінні в URL-шляху. Вони використовуються для вказівки на певний ресурс у колекції. Ми можемо визначте кілька параметрів PATH, і кожен з них представлено фігурною дужкою {}. Це призведе до списку всіх загальнодоступних сховищ для вказаного користувача зі значенням ім’я користувача.
Є кілька способів передати параметри в REST API:
- Параметри запиту: – Додається в кінці URL-адреси. – Відображається в URL-адресі запиту. …
- Заголовки запитів: – включено до заголовків HTTP. – Використовується для такої інформації, як маркери автентифікації. …
- Тіло запиту: – використовується для більш складних даних. …
- Параметри шляху/URL:
Параметри шляху з багатьма об’єктами можна серіалізувати кількома способами:
- Розгортання у стилі шляху (матриця), використовуючи крапку з комою, наприклад /map/point; x=50;y=20.
- Розширення мітки – за допомогою крапок, наприклад /color. R=50. G=150. B=100.
- Стиль, розділений комами, наприклад /users/12,34,56.
Процедура
- Відкрийте API для редагування, як описано в Редагування визначення API OpenAPI 2.0.
- Якщо вже визначено один або кілька Шляхів, розгорніть Шляхи.
- Щоб створити новий шлях, натисніть значок додавання. поряд із Шляхами на навігаційній панелі. …
- Якщо ви створюєте новий шлях, натисніть «Створити». …
- Натисніть Зберегти, коли закінчите.
Параметри шляху є параметри запиту, приєднані до URL-адреси, які вказують на певний ресурс REST API. Параметр шляху відокремлюється від URL-адреси символом "/", а від параметра(ів) запиту – знаком питання ("?").