1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/blocklang-blocklang-installer

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
01_installers.md 11 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 28.11.2024 14:16 74c51cd

Программное обеспечение

Регистрация информации об установщике на платформе Block Lang

Необходимо связать установщик BlockLang с проектом на платформе https://blocklang.com, чтобы он автоматически управлял развёртыванием проекта.

POST /installers

При регистрации необходимо зарегистрировать информацию о сервере.

Имя Тип Описание
registrationToken string Обязательный. Платформа Block Lang генерирует уникальный регистрационный токен для каждого проекта.
ip string IP-адрес сервера.
port int Порт, на котором сервер отвечает на запросы к службе Block Lang (не реализовано).
appRunPort int Порт запуска Spring Boot jar на сервере.
osType string Конкретный тип операционной системы сервера, например, Windows, Ubuntu.
osVersion string Номер версии операционной системы сервера.
targetOs string Тип операционной системы сервера, такой как Windows, Linux, Macos, Solaris.
arch string Архитектура процессора.
serverToken string Обязательный. Используется для уникальной идентификации сервера, используя MAC-адрес сервера.

Примечание: зачем добавлять target_os, если есть более конкретный osType? Это сделано для того, чтобы уменьшить преобразования и напрямую получить информацию о выпуске приложения на основе target_os.

Ответ:

Проверка входных параметров

Status: 422 Unprocessable Entity

Только после прохождения следующих проверок можно начать регистрацию:

  1. Все входные параметры имеют значения.
  2. Не удалось получить основную информацию об APP на основе регистрационного токена.
  3. Основная информация о выпуске APP не существует.
  4. Информация о файле выпуска APP не существует.
  5. Информация о выпуске JDK не существует.
  6. Основная информация JDK не существует.
  7. Информация о файле выпуска JDK не существует.

Регистрация прошла успешно

Status: 201 CREATED
Имя Тип Описание
installerToken string Токены, сгенерированные платформой Block Lang для каждого установщика.
appName string Полное имя Spring Boot jar, который будет развёрнут, состоит из имени пользователя и имени проекта на платформе Block Lang, в формате @userName/projectName.
appVersion string Версия Spring Boot jar для развёртывания.
appFileName string Полное имя файла Spring Boot jar для развёртывания, которое соответствует имени в центре публикации.
appRunPort int Порт запуска Spring Boot jar на сервере.
jdkName string Имя JDK, зарегистрированное на платформе Block Lang.
jdkVersion string Полная версия JDK.
jdkFileName string Полное имя файла JDK на сервере, названное таким образом.

Получение последней информации о программном обеспечении от платформы Block Lang

Обновите информацию о сервере и получите последнюю версию информации о программном обеспечении.

Обратите внимание, что в installer_config.toml хранится только installer_token, но не registration_token, поэтому при получении обновлённой информации используется installer_token.

PUT /installers

Параметры

Имя Тип Описание
installerToken string Обязательно. Токены, созданные платформой Block Lang для каждого установщика.
ip string IP-адрес сервера.
port int Порт, на котором сервер отвечает на запросы к службе Block Lang.
osType string Конкретный тип операционной системы сервера, например, Windows, Ubuntu.
osVersion string Номер версии операционной системы сервера.
targetOs string Тип операционной системы сервера, такой как Windows, Linux, Macos, Solaris.
arch string Архитектура процессора.
serverToken string Обязательный. Используется для уникальной идентификации сервера, используя MAC-адрес сервера.

Ответ:

Проверка входных параметров

Status: 422 Unprocessable Entity

Только после прохождения следующих проверок можно продолжить регистрацию:

  1. Все входные параметры имеют значения.
  2. Невозможно получить основную информацию об установщике на основе токена установщика.
  3. Убедитесь, что токен сервера на платформе Block Lang совпадает с параметром serverToken.
  4. Основная информация об APP не существует.
  5. Основная информация APP не существует.
  6. Последняя информация о выпуске APP не существует.
  7. Последняя информация о файле выпуска APP не существует.
  8. Информация о выпуске JDK не существует.
  9. Основная информация JDK не существует.
  10. Информация о файле выпуска JDK не существует.

Получение информации об обновлении прошло успешно

Status: 200 OK
Имя Тип Описание
installerToken string Токен, созданный платформой Block Lang для каждого установщика.
appName string Полное имя Spring Boot jar, который будет развёрнут, состоит из имени пользователя и имени проекта на платформе Block Lang, в формате @userName/projectName.
appVersion string Версия Spring Boot jar для развёртывания.
appFileName string Полное имя файла Spring Boot jar для развёртывания, которое соответствует имени в центре публикации.
appRunPort int Порт запуска Spring Boot jar на сервере.
jdkName string Имя JDK, зарегистрированное на платформе Block Lang.
jdkVersion string Полная версия JDK.
jdkFileName string Полное имя файла JDK на сервере, названное таким образом.

Отмена регистрации информации об установщике на платформе Block Lang

DELETE /installers/{installerToken}

Параметры

Имя Тип Описание
installerToken string Обязательно. Токен, созданный платформой Block Lang для каждого установщика.

Ответ:

Установщик, который нужно отменить, не существует

Status: 404 NOT FOUND

Отмена прошла успешно

Status: 204 NO CONTENT

Структура installer_config.toml

Имя Описание
url URL программного обеспечения Block Lang, например, https://blocklang.com.
installer_token Уникальный токен, созданный для каждого установщика.
server_token Используется для уникальной идентификации сервера с использованием MAC-адреса сервера.
app_name Полное имя Spring Boot jar, которое будет развёрнуто, состоит из имени пользователя и имени проекта на платформе Block Lang, в формате @userName/projectName.
--- ---
app_version Версия Spring Boot jar, которую необходимо развернуть.
app_file_name Полное имя файла Spring Boot jar, которое должно совпадать с именем в центре публикации.
app_run_port Порт, на котором запускается Spring Boot jar на сервере.
jdk_name Имя JDK, зарегистрированное на платформе Block Lang.
jdk_version Полная версия JDK.
jdk_file_name Полное имя файла JDK, под которым он будет размещён на сервере.

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/blocklang-blocklang-installer.git
git@api.gitlife.ru:oschina-mirror/blocklang-blocklang-installer.git
oschina-mirror
blocklang-blocklang-installer
blocklang-blocklang-installer
master