Перший Backend плагін (preview)

Створення плагіну на підставі шаблону

Зараз ми розробимо базовий бекенд плагін для публікації на платформі preview MEF.DEV. Для розробки цього плагіна необхідні лише знання щодо написання коду на C#

Дотримуйтесь інструкцій і дізнайтеся, як створити свій перший плагін, який надаватиме доступ до Ваших даних або за Вашою бізнес логікою.

Зробіть копію тестового проекту із репозиторію

// посилання на репозиторій https://github.com/mef-dev/tutorial-backend-plugin

Крок 1. Створення нового проекту

Відкрийте проект в Visual Studio, додайте в перелік джерел NuGet пакетів

// посилання на сервер NuGet пакетів https://nuget.mef.dev/v3/index.json

У Вас з’явиться доступ до пакетів доступних до використання на платформі

Крок 2. Відновлення пакетів для нового проекту

Структура платформи довільна, головне дотримуватися правил визначення атрибутів для класів плагінів і сутностей

Для продовження роботи Вам потрібно відновити пакети для скачаного проекту, якщо проект створюється з нуля – додати в проект пакет UCP.Common.Plugin - саме цей пакет виконує функції контракту до Вашого пакету бізнес-логіки або даних

Крок 3. Внесення змін в проект

Унікальним ідентифікатором на платформі є назва проекту, а також назва сутності (entity) – тож перейменовуємо проект і модифікуємо назву сутності

Визначте унікальний Export і ModuleName, який співпадає з назвою проекту

Якщо є необхідність в збереженні даних для вказаної сутності, необхідно наслідувати клас BaseEntity для усіх класів які будуть передаватися у плагін або отримуватися з нього

Назва експортованого класу (contractName) для роботи з сутністю на POST для плагіну повинна співпадати з назвою плагіну. Назви сутностей на отримання даних повинні наслідувати BaseEntity але назва contractName може бути довільною. Після внесених модифікацій можна зібрати архів для завантаження на платформу. Важливо аби архів містив залежності проекту - найпростіше викликати команду з консолі dotnet publish і увесь вміст папки помістити до zip архіву.

Реєстрація плагіну на платформі

Для цього повинно бути зареєстрованим користувачем платформи із ролью Developer - якщо Ви не зареєстровані то під час логіну до платформи за адресою https://preview.mef.dev Вам буде надано можливості здійснити реєстрацію

Крок 4. Завантаження плагіну

Перейдіть до переліку ваших плагінів, натисніть створити новий плагін

Заповніть форму вказавши актуальну інформацію – для початку визначте для плагіну тип API

Назва і описи, зображення до плагіну довільні. Після заповнення основної інформації, натисніть «Зберегти» і після цього з'явиться змога завантажити підготований плагін на платформу

Якщо завантаження пройшло успішно, то в переліку доступних версій з’явиться щойно завантажений плагін

Обираємо необхідну версію і натискаємо «Зберегти».

З цього моменту сутності сервісу стають доступні для зверненню по API. Можемо перевірити результат завантаження використовуючи любий REST клієнт.

Крок 5. Перевірка завантаженого плагіну використовуючи REST client

Користувача для доступу до API можна створити в розділі Security свого профілю, куди можна потрапити натиснувши на іконку користувача у верхньому правому кутку і вибравши пункт меню Profile. Після натискання на кнопку Set password Ви зможете задати логін користувача і пароль для авторизації Basic Auth

Версійність змін плагіну

Коли виникне необхідність оновити плагін, потрібно внести необхідні зміни, змінити версію пакету і зібрати архів як і при першому завантаженні, завантажити на платформу, змінити версію пакету обравши з випадаючого списку