DongTai-webapi

中文版本(Chinese version)

Что такое DongTai-WebApi?

DongTai-WebAPI используется для управления пользовательскими ресурсами, включая:

• управление проектами;
• управление уязвимостями;
• получение данных пользователя;
• настройку системных ресурсов;
• управление пользователями и ролями;
• управление развёртыванием агентов;
• управление арендаторами;
• извлечение документов о развёртывании.

Развёртывание

Развёртывание исходного кода

1. Установите необходимые зависимости:

python -m pip install -r requirements-test.txt

2. Инициализируйте базу данных:

— установите MySQL 5.7, создайте базу данных DongTai-webapi и запустите файл базы данных conf/db.sql; — перейдите в каталог webapi и выполните команду python manage.py createsuperuser, чтобы создать администратора.

Или используйте способ Docker для размещения базы данных:

— извлеките соответствующие образы баз данных и запустите их:

docker pull  registry.cn-beijing.aliyuncs.com/huoxian_pub/dongtai-mysql:latest 
docker run -itd --name dongtai-mysql -p 3306:3306 registry.cn-beijing.aliyuncs.com/huoxian_pub/dongtai-mysql:latest

3. Измените файл конфигурации:

— скопируйте файл конфигурации conf/config.ini.example в conf/config.ini и измените конфигурацию; URL, соответствующий engine, — это служебный адрес DongTai-engine, а URL, соответствующий apiserver, — служебный адрес DongTai-openapi.

4. Запустите службу:

— выполните python manage.ru runserver, чтобы запустить службу.

Контейнерное развёртывание

1. Инициализация базы данных:

— извлеките соответствующие изображения баз данных и запустите их.

docker pull  registry.cn-beijing.aliyuncs.com/huoxian_pub/dongtai-mysql:latest 
docker run -itd --name dongtai-mysql -p 3306:3306 registry.cn-beijing.aliyuncs.com/huoxian_pub/dongtai-mysql:latest

2. Измените файл конфигурации:

скопируйте файл конфигурации conf/config.ini.example в conf/config.ini и измените конфигурацию. Среди них: — URL, соответствующий engine, — это служебный адрес DongTai-engine; — URL, соответствующий apiserver, — это служебный адрес DongTai-openapi.

3. Создайте образ:

$ docker build -t huoxian/dongtai-webapi:latest .

4. Запустите контейнер:

$ docker run -d -p 8000:8000 --restart=always --name dongtai-webapi huoxian/dongtai-webapi:latest

Документация

— API-документация, соответствующая проекту.

1. Добавьте параметры, связанные с документом, при запуске контейнера:

$ docker run -d -p 8000:8000 --restart=always -e environment=DOC --name dongtai-webapi huoxian/dongtai-webapi:latest

Здесь вам нужно запустить соответствующую базу данных MySQL. Если вы хотите только запустить проект webapi для просмотра документа, вам необходимо добавить следующий параметр -e database=sqlite (запустить только проект webapi, чтобы просмотреть документ, и не гарантировать совместимость с sqlite), полная команда:

$ docker run -d -p 8000:8000 --restart=always -e environment=DOC -e database=sqlite --name dongtai-webapi huoxian/dongtai-webapi:latest

2. Получите доступ к соответствующему API в контейнере:

Адрес Swagger-ui — http://<containerip:port>/api/XZPcGFKoxYXScwGjQtJx8u/schema/swagger-ui/#/.

Адрес Redoc — http://<containerip:port>/api/XZPcGFKoxYXScwGjQtJx8u/schema/redoc/.

Если вам нужно отдельно экспортировать swagger.json, адрес — http://<containerip:port>/api/XZPcGFKoxYXScwGjQtJx8u/schema/

3. Конкретный режим аутентификации API включён в документ API, и соответствующий токен можно использовать. Найдено в части агента установки в сети.

Дополнительные ресурсы

• Документация
• Сайт DongTai