1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-01-26 05:37:27 +02:00

Update README.md

This commit is contained in:
Anton Titovets 2024-04-14 21:39:17 +03:00 committed by GitHub
parent b7d620775a
commit c4f4e7845c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -6,12 +6,12 @@
[![OpenYellow](https://img.shields.io/endpoint?url=https://openyellow.neocities.org/badges/2/736878759.json)](https://openyellow.notion.site/openyellow/24727888daa641af95514b46bee4d6f2?p=f78cea2066114067ab9069f06206219d&pm=s)
<br>
Набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise и OneScript <br>
Набор инструментов для интеграции с некоторыми популярными API посредством CLI, 1C:Enterprise или OneScript <br>
<br>
Проект состоит из общих модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех. Реализованные методы выполняют конечные задачи (вроде ОтправитьСообщение() или СоздатьПост()), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент. <br><br>
Кодовая база проекта состоит из модулей, каждый из которых отвечает за свой API, а также нескольких модулей-инструментов, общих для всех библиотек. Реализованные методы выполняют конечные задачи (вроде ОтправитьСообщение или СоздатьПост), что позволяет использовать их без углубления в реализацию. Однако, код, при этом, достаточно сильно декомпозирован - методы авторизации, получения данных и пр. по возможности вынесены в отдельные функции. Это позволяет легко добавлять новые методы, даже если они еще не реализованы в самой библиотеке на текущий момент. <br><br>
На данный момент реализованы методы для работы со следующими API:
<br>
@ -31,21 +31,28 @@
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/bayselonarrend/OpenIntegrations/total?logo=github)](https://github.com/Bayselonarrend/OpenIntegrations/releases/latest)
Релизы библиотеки выходят в четырех вариантах:
Релизы библиотеки выходят в пяти вариантах:
- Как CLI приложение для Windows и Linux (exe, rpm, deb)
- Как XML файлы расширения для загрузки через конфигуратор
- Как EDT проект расширения
- Как отдельный файл расширения формата cfe
- Как OneScript пакет расширения ospx.
- Как OneScript пакет расширения ospx
Помимо этого, вы можете просто скопировать код общих модулей из релизов в свой проект вручную. Однако, вне зависимости от выбранного сопособа установки, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.
<br/>
При использовании версий для 1С и OneScript, вы также можете просто скопировать код общих модулей из релизов в свой проект руками. Однако, вне зависимости от выбранного сопособа установки, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.
<br/>
Для начала работы в OneScript дополнительно необходимо установить пакет из скачанного ospx файла
<br/>
```
opm install -f ./OInt-1.0.0.ospx
```
CLI версия дополнительно требует **.Net Framework 4.8** или **Mono соответствующей версии**. При установке из rpm или deb пакетов устанавливается автоматически
<br/>
>[!WARNING]
@ -55,10 +62,13 @@
## Документация ##
У ОПИ есть подробная документация с примерами по адресу [https://opi.neocities.org](https://opi.neocities.org). Там вы можете найти как общие положения о начале работы с каждым конкретным API, так и описания каждого метода с примерами кода и возвращаемых значений.
У ОПИ есть подробная документация с примерами по адресу [https://opi.neocities.org](https://opi.neocities.org). Там вы можете найти как общие положения о начале работы с каждым конкретным API, так и описания каждого метода с примерами кода, параметров и возвращаемых значений.
![Docs](https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/docs.png)
CLI версия имеет собственную встроенную справку по всем методам
___
@ -73,6 +83,7 @@ ___
>- [Telegram в режиме форума: делаем чаты комфортными](https://infostart.ru/1c/articles/2055811/)<br>
>- [Открытый пакет интеграция для OneScript](https://infostart.ru/1c/articles/2060307/)<br>
>- [Библиотека для работы с Google Drive API (open-source)](https://infostart.ru/1c/articles/2066469/)<br>
>- [OInt CLI - приложение Открытого пакета интеграций для командной строки](https://infostart.ru/1c/articles/2074205/)<br>
>- Открытый Пакет интеграций (OpenIntegrations)<br>