Aiplan API

Автоматически сгенерированная библиотека доступа к API АИПлана.

📦 Установка

npm install @aisa-it/aiplan-api-ts
# или
yarn add @aisa-it/aiplan-api-ts

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

Инициализация клиента

import { Users } from '@aisa-it/aiplan-api-ts/src/Users'

const usersApi = new Users({ baseURL: 'https://domain.com' }) // явное указание адреса для запросов
// или
const usersApi = new Users() // запросы будут идти на тот адрес, где расположено само приложение

При использовании второго способа могут возникать проблемы с локальной разработкой. Например, запросы будут уходить на localhost:9000 Чтобы исправить это нужно настроить прокси. Пример прокси в Quasar(quasar.config.js)

    devServer: {
      proxy: {
        '/api': {
          target: 'https://domain.com',
          changeOrigin: true,
        },
      },
    },

Пример запроса

import { DtoUser } from '@aisa-it/aiplan-api/data-contracts'

async function getUserInfo(): Promise<DtoUser> {
    try {
        const data = await usersApi.getCurrentUser()
        console.log('userInfo:', data)
    } catch (error) {
        console.error('Error:', error)
    }
}

🚀 Релиз новой версии пакета

yarn version повысит сам версию, сделает коммит и повесит тег текущей версии.

yarn version --minor
git push
git push --tags

Правила версий

• major - Глобальные изменения, полностью несовместимые с прошлым API
• minor - Регулярные обновления текущего API. Сборка АИплана обновляет это число
• patch - Мелкие косметические исправления

📜 Лицензия

Этот проект распространяется под лицензией MPL-2.0 См. файл LICENSE для получения дополнительной информации.