Как сделать REST API с описанием в формате Swagger(python)?

Question

[NickTheBuilder]

Добрый день!
Не могу разобраться в том, как же работает свеггер, а точнее, в каком порядке выполнять работу.
Суть работы: надо разработать API для управления иерархическим списком, данные для списка должны храниться в СУБД. Серверная часть должна представлять из себя REST API с описанием в формате Swagger. Приложения должны запускаться внутри Docker. И я не совсем понимаю порядок действий и как работать с свеггером. Сначала отдельно написать веб приложение, а потом работать с этим в свеггере? Или как?
Буду благодарен любой полезной информации, спасибо

Comments

[Astrohas]

А какой фреймворк?

[NickTheBuilder]

Astrohas, я решил использовать flask

[NickTheBuilder]

Astrohas, как пример написания самого приложения решил использовать эту статью https://habr.com/ru/post/246699/

[Max Payne]

Тестовое задание?

[NickTheBuilder]

Max Payne, да

Answer 1

[Astrohas]

https://github.com/noirbizarre/flask-restplus
https://flask-restplus.readthedocs.io/en/stable/sw...

Answer 2

[dmitriy]

1. Описание модели предметной области (справочник сущностей, методы, отношения)
2. Создание Swagger на основе модели предметной области
3. Реализация серверной части АПИ на основе swagger документации (можно сгенерировать каркас на основе swagger схемы в swagger online editor)
4. Реализация клиента (можно воспользоваться тем же swagger online editor для генерации клиента)

п.с. 3 и 4 могут делаться паралельно

Comments

[NickTheBuilder]

спасибо за ответ, подскажи пожалуйста, что понимается под описанием модели предметной области?

[dmitriy]

например у вас есть ТЗ.
1. Пользователь сайта имеет возможность зарегистрироваться в системе, путем заполненение формы и полей... (перечень полей)
2. Пользователь сайта может авторизоваться введя логин и пароль в форме авторизации.
3. Авторизованный пользователь имеет возможность просмотреть перечень ранее созданных заказов перейдя на страницу История заказов
из выше перечисленных требований можно сформировать справочник сущностей:
- Пользователь
- Заказ
Теперь описываем поведение:
- Пользователь (зарегистрироваться в системе - создание пользователя, авторизовация)
- Заказ (показать список заказов)
Итог:
POST /api/user/ - создание пользователя
POST /api/user/auth/ - авторизация
GET /api/user/orders/ - заказы пользователя
GET /api/user/orders/1/ - заказ пользователя

[NickTheBuilder]

dmitriy, спасибо, понял, в моем случае мне надо сделать иерархический список, данные которого будут храниться в СУБД, можешь ли ты подсказать, как связать swagger и какую либо СУБД?

[dmitriy]

swagger никак не связан с СУБД

[dmitriy]

работа с СУБД связана с реализацией сервера, видимо Вы выбрали PYTHON , значит будите использовать питонновский инструмент, возможно какую то ORM