MIAO

— профессиональный переводчик и технический редактор в сфере IT —

MIAO

EN | 中文

What is MIAO?

MIAO («Miao Is A web demO generator», произносится /mjɑʊ/) — это ненавязчивый генератор веб-демо, который быстро преобразует функцию или фрагмент кода в веб-интерфейс для временных демонстраций или тестов без сложной настройки.

MIAO не является веб-фреймворком, его фокус сильно отличается от веб-фреймворка. MIAO в основном используется для создания небольших временных демо или небольших онлайн-инструментов, а не для использования в производственных средах, и не рекомендуется для официальных проектов.

MIAO — это компромисс между гибкостью и простотой использования, в основном ориентированный на предоставление удобного, готового к использованию временного веб-генератора демо, без предоставления слишком большой конфигурации и пользовательских функций UI/взаимодействия, и не похож на веб-фреймворк, такой как «Контроль разрешений», «Маршрутизация», «Рендеринг шаблонов», «Сессия» и другие функции. Небольшое временное демо можно создать быстро всего за три шага. Импортировать библиотеку -> Добавить аннотации -> Запустить сервер

В настоящее время MIAO поддерживает только Java и Python, поддержка других языков (таких как Golang, Haskell) будет добавлена позже, так что следите за обновлениями.

Как использовать?

Этот инструмент ещё не полностью разработан, в настоящее время можно использовать только некоторые основные функции, остальные функции планируется реализовать в разделе «Дорожная карта» позже.

В pom.xml (Maven).

<dependencies>
    <dependency>
        <groupId>cn.voidnet</groupId>
        <artifactId>MIAO</artifactId>
        <version>0.0.10</version>
    </dependency
</dependencies>

Или вы можете перейти в раздел «Release» и загрузить jar-файл, чтобы добавить его в каталог внешних библиотек зависимостей вашего проекта.

Затем просто добавьте аннотацию @WebDemo к функции, для которой вы хотите сгенерировать интерфейс (очевидно, только статические функции).

      @WebDemo
    public static int getRandomNumber(int min, int max) {
        return new Random().nextInt(max - min + 1) + min;
    }

Наконец, в основной функции (или где угодно, где вы хотите запустить службу), просто запустите серверную часть инструмента.

    public static void main(String[] args) {
        MIAO.start();
    }

Функция start() будет блокироваться при выполнении, поэтому поместите эту строку кода после остальной части вашего кода в main или откройте новый поток для обслуживания этого инструмента.

После этого вы сможете автоматически генерировать временное демо. !

Нажмите «Выполнить», чтобы выполнить и получить возвращаемое значение: !

!

Конечно, этот инструмент также предоставляет некоторые простые параметры настройки, например, вы можете изменить имена параметров функции и т. д.: !

@WebDemo("Add two numbers")
public static double add(
        @Parameter("operand1") double opr1,
        @Parameter("operand2") double opr2
) {
    return opr1 + opr2;
}

! Заголовок выше также можно изменить с помощью следующих параметров:

MIAO.start("Cat Ear Switch Controller");

[image:7698089C-E420-4322-BC71-4E2D3D77EA28-33798-00012951A6E99FCB/4C9314FA-D50A-4DC9-8D5A-285070BF659B.png]

Дополнительные элементы настройки будут добавлены в будущем (например, способ отображения возвращаемых значений, возможность выбора параметров из необязательных и т.д.)

PS: Если вы используете Gradle, пожалуйста, добавьте mavenCentral() в репозитории, а затем представьте эту библиотеку.

PPS: Пожалуйста, установите функцию, которую вы хотите использовать для генерации веб-демонстрации, и класс, в котором она находится, как общедоступные, чтобы обойти ограничения отражения Java.

PPPS: Поскольку этот инструмент ещё не доработан, пока поддерживаются только базовые типы данных для параметров функций и возвращаемых значений. Поддержка «изображений», «таблиц», «диаграмм», «объектов», «файлов», «видео», «функциональных изображений» будет добавлена позже. См. раздел «Дорожная карта».

Что означает название?

MIAO — аббревиатура от «Miao Is A web demO generator» и китайский слог, используемый для описания. Варианты для пользовательского интерфейса в будущем? Например, предоставьте API для изменения структуры или стиля пользовательского интерфейса.

Если у вас сложные требования к пользовательскому интерфейсу, веб-фреймворк может быть лучшим выбором.

Конечно, мы не исключаем возможность добавления некоторых простых настроек темы пользовательского интерфейса для изменения стиля или цвета пользовательского интерфейса, но не будем предоставлять такие сложные API настройки, как «изменение веб-структуры и макета CSS-стиля пользовательского интерфейса».

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

Вклад кода

Если вы заинтересованы в этом проекте, вы также можете внести свой вклад в этот проект, разветвив его и отправив PR.

Если у вас возникнут проблемы с кодом или вы обнаружите ошибки, вы можете оставить отзыв через Issue или связаться со мной напрямую, и я отвечу как можно скорее.

Контакт: thevoid2333@gmail.com Или просто создайте issue.