Использование переменных в проекте с пасекой

63
5

можно определить какой-то постоянный параметр, который мы можем повторно использовать в нескольких запросах? Например, если у меня есть несколько конечных точек и во всех них мне нужен один и тот же идентификатор (например, идентификатор книги), есть ли возможность определить один раз в документе этот идентификатор и ссылаться на него в значениях примера, необходимых для определений запроса?

Наподобие:

bookId := '563'
...........

Книги [/books/{book_id}]

    параметры
      book_id (обязательно, номер, {bookId})

Заранее спасибо.

спросил(а) 2021-01-25T14:17:42+03:00 4 месяца, 3 недели назад
1
Решение
139

Похоже, вы хотите использовать MSON. MSON позволяет описывать объекты (например, книгу) и использовать объект в запросах/ответах. Объекты могут наследовать друг от друга, а значения могут быть переопределены в других объектах или непосредственно в разделе "Атрибуты запроса/ответа".

Пример:

## Example Object(object) - Comment about Example Object
+ 'someKey': 'someValue' (string, required) - Required String value

Пример книги:

# Data Structures
## Page (object) - A page in a book
+ 'pageNumber' (number, required) - The number of the page

## Book (object) - A book
+ 'numPages' (number, required) - The number of pages in the book
+ 'title' (string, required) - The title of the book
+ 'author' (string, required) - The author of the book
+ 'pages' (array[object], required) - The pages in the book

## Book Collection (object) - A collection of books
+ books (array[object]) - The books in the collection

# API calls
## Example call [exaple/endpoint]
## Add new book (POST)
+ Request 200 (application/json; charset=utf-8)
+ Attributes (Book)
+ Response 201 (application/json; charset=utf-8)
+ Attributes (Book)
### Get all books (GET)
+ Request 200 (application/json; charset=utf-8)
+ Response 200 (application/json; charset=utf-8)
+ Attributes (Book Collection)

ответил(а) 2021-01-25T14:17:42+03:00 4 месяца, 3 недели назад
Ваш ответ
Введите минимум 50 символов
Чтобы , пожалуйста,
Выберите тему жалобы:

Другая проблема