Skip to main content

API Документація - Інструменти

Все з прикладами на документацію, прикладами команд

для роботи підключіть проект dev

Вигрузка в MD основних даних по таблицях або схемі​

Реалізована API db-schema-structure дозволяє вивантажувати структури схеми чи таблиці бази даних.

💡 Tip

API доступна для виклику з будь-яких порталів, підключення відбувається автоматично до бази даних порталу, з якого йде виклик API.

Приклад виклику структури схеми:

/api-user/db-schema-structure/admin

Приклад виклику структури таблиці:

/api-user/db-schema-structure/admin.users

Результат містить:

  • Розмежування за таблицями
  • Приклад даних (10 записів таблиці)
  • Перелік полів таблиці (назва, тип поля, підпис українською)

Вигрузка структури БД схеми чи таблиць в формат схеми ERD​

Реалізована API db-schema дозволяє сформувати структуру схеми чи окремої таблиці в форматі DBML (Database Markup Language) - зокрема, для інструменту dbdiagram.

Приклад виклику структури схеми:

/api-user/db-schema/admin

Приклад виклику структури таблиці:

/api-user/db-schema/admin.users

Результат містить розмежування за таблицями та їх деталізовану структуру, включно з підписами, типами полів, pk та ін.

💡 Tip

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

Після формування dbdiagram наявна можливість опублікування сторінки структури ERD в документацію проєкту. Для цього необхідно зробити вставку через iframe. Приклад коду вставки:

<iframe src="https://dbdiagram.io/d/64edec6f02bd1c4a5e9c27ee" width="800" height="480" frameborder="0"></iframe>

Результат вставки (реальний приклад):

Вигрузка ERD в форматі SQL​

API db-schema-md генерує md файл, всередині якого в форматі SQL описані таблиці вказаної користувачем схеми.

Приклад виклику структури схеми:

/api-user/db-schema-md/admin

Приклад виклику структури таблиці:

/api-user/db-schema-md/admin.users

Вивід карти​

Створені карти можна вивести в документацію за допомогою бібліотеки Leaflet.

Для вставки карти необхідно знати посилання на шар/карту в форматі TMS сервісу, наприклад https://data.softpro.ua/api-user/rtile/voyager/ua/{z}/{x}/{y}.png

Приклад коду leaflet

Details
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css"
    integrity="sha256-p4NxAoJBhIIN+hmNHrzRCf9tD/miZyoHS5obTRR9BMY="
    crossorigin=""/>

<script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js"
    integrity="sha256-20nQCchB9co0qIjJZRGuk2/Z9VM+kNiyxNV1lvTlZBo="
    crossorigin=""></script>
<div id="map" style="height: 300px;width:100%"></div>
<script>
var map = L.map('map').setView([50, 30], 7);
L.tileLayer('https://data.softpro.ua/api-user/rtile/voyager/ua/{z}/{x}/{y}.png', {
    maxZoom: 18,
    minZoom: 6,
    maxBounds: [
    //south west
    [44, 24],
    //north east
    [53, 42]
    ],
    attribution: '&copy; ДП "НДІГК" та Учасники OpenStreetMap'
}).addTo(map);
</script>

Приклад вставлення карти:

Details
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.9.4/dist/leaflet.css"
     integrity="sha256-p4NxAoJBhIIN+hmNHrzRCf9tD/miZyoHS5obTRR9BMY="
     crossorigin=""/>

 <script src="https://unpkg.com/leaflet@1.9.4/dist/leaflet.js"
     integrity="sha256-20nQCchB9co0qIjJZRGuk2/Z9VM+kNiyxNV1lvTlZBo="
     crossorigin=""></script>
<div id="map" style="height: 350px;width:100%"></div>
<script>
var map = L.map('map').setView([50, 30], 7);
L.tileLayer('https://data.softpro.ua/api-user/rtile/voyager/ua/{z}/{x}/{y}.png', {
    maxZoom: 18,
    minZoom: 6,
        maxBounds: [
        //south west
        [44, 24],
        //north east
        [53, 42]
    ],
    attribution: '&copy; ДП "НДІГК" та Учасники OpenStreetMap'
}).addTo(map);
</script>

Сформувати дерево папок/файлів​

Є можливість вивантажити зміст проєкту чи окремих його папок (сховищ) у формат деревовидної структури.

Для формування необхідно виконати такі дії:

  1. Зайти через консоль на сервер, де розташований проєкт.
  2. Перейти до папки проєкту та подальших папок, структура яких необхідна. Приклад розміщення - /data/softpro/server/cardinal/
  3. Виконати команду treee -l 2. Результат скопіювати та вставити у документацію відповідного проєкту.

Приклад результату:

SITE                        - module SITE/GEOportal PUBLIC
├── vue                     - project vue component
├── public                  - static content
│   ├── js                  - скріпти - ( можна cdn )
│   ├── tpl                 - стилі
│   ├── fonts               - шрифти
├── sass                    - вихідні стилі saas
│   ├── main.css
│   ├── home.css
└── templates               - шаблони
    ├── cls                 - незмінні класифікатори
    ├── form                - форми json
    ├── interface           - інтерфейси адмін частини
    ├── pt                  - частини шаблонів - для інтерфейсів та шаблонів
    ├── siteTemplate        - шаблони сторінок сайту
    └── table               - таблиці
💡 Tip

За наявності помилки в консолі після виконання команди "The term 'treee' is not recognized..." необхідно встановити цю бібліотеку на сервер, де виконується команда. Встановити бібліотеку на сервер - команда

apt install tree

Повний та реальний приклад структури: https://docs.softpro.ua/dev/3.Template/0.structure/

Вивід VUE компоненти​

✏️ Note

Дозволяє переглядати створені VUE компоненти та взаємодіяти з ними напряму через сторінку документації.