autodroid sdk

AutoDroid SDK

---

Индекс

• На
• Прежде чем начать
• ???‍ Использование
• Обзор проекта
• ⛏️ Используемые технологии
• ?? Взносы
• ? Журнал изменений
• Ссылки

На

Этот проект начинается с необходимости предлагать инструменты DroidAugmentor и MalSynGen в качестве услуги, представленные в AutoDroid.

Этот SDK был разработан для облегчения интеграции и разработки приложений, которые хотят подключаться к API AutoDroid.

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

Проект также можно использовать через эту коллекцию Postman.

Откройте для себя проект Malware Datalab!

Прежде чем начать

Серверная часть приложения использует Firebase для аутентификации и авторизации пользователей. Чтобы использовать приложение, необходимо создать проект в Firebase и настроить учетные данные для доступа, как в Firebase.

???‍ Использование

Установите эту библиотеку, используя ваш любимый менеджер пакетов:

yarn add autodroid
# ou
npm install autodroid
# ou
pnpm install autodroid

После настройки Firebase вы можете использовать библиотеку для подключения к API AutoDroid:

 import { AutoDroidSdk } from "autodroid" ;

const autoDroid = new AutoDroidSdk ( {
  baseUrl : "https://mdl-api.unihacker.club/graphql" ,

  getAuthToken : async ( ) => {
    const token = ( await firebaseAuth . currentUser ?. getIdToken ( ) ) || "" ;
    return token ;
  } ,

  onAuthError : ( ) => {
    // OPTIONAL: add your logic here for Authentication Error
  } ,

  onGraphQLError : error => {
    // OPTIONAL: add your logic here for GraphQL Errors
  } ,

  onNetworkError : error => {
    // OPTIONAL: add your logic here for Network Errors
  } ,
} ) ;

export { autoDroid } ;

Используйте экземпляр autoDroid для выполнения операций, доступных в API, таких как:

 import { autoDroid } from "./api" ;

const start = async ( ) => {
  const response = await autoDroid . processing . requestDatasetProcessing ( {
    data : {
      dataset_id : "..." ,
      processor_id : "..." ,
      parameters : [
        {
          name : "training_algorithm" ,
          value : "RandomForest,SupportVectorMachine,DecisionTree" ,
        } ,
        {
          name : "number_epochs" ,
          value : "100" ,
        } ,
      ] ,
    } ,
  } ) ;

  console . log ( response . status ) ;
} ;

start ( ) ; 

Обзор проекта

API вставлен в контекст проекта AutoDroid, который представляет собой приложение, целью которого является предоставление инструмента DroidAugmentor/MalSynGen в качестве услуги.

⛏️ Используемые технологии

• TypeScript — язык программирования
• Node.js — среда выполнения
• Клиент Apollo — клиент GraphQL
• GraphQL Codegen — генератор кода GraphQL
• Yarn — Менеджер пакетов

Общий

Важно упомянуть и другие инструменты, которые будут использоваться в обеих частях проекта:

• Git — контроль версий
• Хаски — Git Hooks
• Lint Staged — инструмент для проверки зафиксированных файлов
• Commitizen — помощник для сообщений о коммитах Git
• Commitlint — проверка сообщений о коммитах Git
• Стандартная версия — генератор журнала изменений
• Eslint — платформа проверки кода
• Prettier — форматировщик кода
• Семвер — семантическое управление версиями

Ссылки

ЛАВИОЛА, Луис Фелипе; ПАИМ, Каюан Олекес; КРЕЙЦ, Диего; МАНСИЛЬЯ, Родриго Брандао. AutoDroid: предоставление инструмента DroidAugmentor в качестве услуги. В: ESCOLA REGIONAL DE RETES DE COMPUTADORES (ERRC), 20. 2023, Порту-Алегри/РС. Анналы [...]. Порту-Алегри: Бразильское компьютерное общество, 2023 г. п. 145-150. DOI: https://doi.org/10.5753/errc.2023.929.