Swagger UI похож на песочницу? Как работает Swagger UI

Question

Я пытаюсь понять, как работает Swagger UI и для какого сценария он подходит. Насколько я понимаю, это не песочница при интеграции с Swagger UI. Это означает, что Swagger UI манипулирует реальными данными. Это верно?

Так что обычно мне приходится создавать специальную тестовую среду для Swagger UI, верно? Звучит не правильно для меня. Даже существует тестовая среда для Swagger UI, так как она открыта для большого количества людей. Означает ли это, что фиктивные данные, опубликованные кем-то, будут сохранены навсегда и видны другим?

Я ожидал, что Swagger UI ведет себя как песочница, которая только сохраняет и манипулирует данными для текущего сеанса. Как только пользователь закроет сеанс, а затем снова откроет его, он должен быть совершенно новым.

Я хотел бы знать типичный сценарий использования Swagger UI.

Answer 1

Это во имя, не так ли? Он генерирует пользовательский интерфейс для вашего API.

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

Если вы хотите последний , вам придется создать это самостоятельно.

Означает ли это, что фиктивные данные, отправленные кем-то, будут сохранены навсегда и видимы для других?

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

Учтите, что Swagger UI предоставляет вам визуальный способ вызова вашего API. Все, что вы можете сделать с Swagger, вы можете сделать с любым клиентом REST / HTTP, как и ваши потенциальные потребители.