Руководство по инструменту управления интерфейсом RAP2

Java

Недавно я хотел написать документ интерфейса для проекта.Первое, что пришло мне в голову, это swagger.Я не думал, что swagger2 очень недружелюбен к реактивному программированию Spring 5, поэтому я искал другие решения получше.

Введение и установка

rap2 — это RAP-инструмент управления интерфейсом с открытым исходным кодом, созданный фронтенд-командой Alimama. В настоящее время это вторая версия. Его преимущество в том, что он может не только легко управлять набором стандартных документов интерфейса, но и предоставлять данные mockjs. Таким образом, нет необходимости, чтобы back-end уходил «до конца» первым, а начинает развиваться front-end, что не только повышает эффективность работы команды, но и снижает связь между front-end и задний конец.

Установить

Последняя версия rap2 официально предоставляет два метода установки.Настоятельно рекомендуется первый метод развертывания докера, который является простым и прямым. Далее идет процесс установки

шаг

  1. местные экологические требования

    Установить Докер

  2. Перетащите проект rap2 в любой локальный каталог (примечание: проект уже содержит redis, mysql)

    git clone git@github.com:thx/rap2-delos.git
    
  3. войти в проект, изменитьdocker-compose.ymlФайл, я лично модифицирую под свои нужды.Я напрямую использую redis и mysql в проекте здесь.Чтобы не конфликтовать с локальным, я изменил порт маппинга.

    // ...
    services:
      # frontend
      dolores:
        image: rapteam/rap2-dolores:latest
        ports:
          #冒号前可以自定义前端端口号,冒号后不要动
          - 4000:38081
    // ...
      redis:
        image: redis:4
        ports:
           - 6479:6379
    // ...
      mysql:
        image: mysql:5.7
        # expose 33306 to client (navicat)
        ports:
           - 3406:3306
    
  4. Извлеките образ и запустите его (Примечание: следующая команда выполняется в каталоге rap)

    docker-compose up -d
    
  5. После запускапервый разЗапуск требует ручной инициализации базы данных mysql (примечание)

    docker-compose exec delos node scripts/init
    
  6. Доступ после успешного развертывания

    http://localhost:4000# внешний интерфейсhttp://localhost:38080# задняя часть

  7. Другое: Отключить рэп-сервис

    docker-compose down
    

Развертывание вручную может относиться кОфициальный сайт

Настройка пользовательских интерфейсов в RAP2

шаг

  1. Внешний вход http://localhost:4000/

  2. Новый склад в правом верхнем углу

  1. Новый модуль -> Новый интерфейс

  1. Нажмите «Импорт» и вставьте пример json напрямую.

  1. На этом этапе самый базовый интерфейсный документ завершен.

фиктивные данные

Хотя удобно импортировать json напрямую, смоделированные данные в нем фиксируются. Друзья, знакомые с mockJs, знают, что данные динамического ответа больше подходят для разработки и отладки. К счастью, рэп также поддерживает спецификацию синтаксиса Mock.js.

Подробные правила грамматики можно посмотретьофициальный мерзавец,илиОфициальный пример(рекомендовать). Вот лишь несколько дополнений к обычным демонстрациям:

тип Создать правила Первоначальный значение Сцены
Number @natural генерировать случайные числа
Number 1-10 Случайное число от 1 до 10
String @name случайное английское имя
String @cname случайное китайское имя
String @city Случайное название города на уровне префектуры.
Function @datetime("yyyy-MM-dd HH:mm:ss ") дата в указанном формате

Нетрудно заметить, что использование этих начальных значений@占位符или@占位符(参数 [, 参数])

тип Заполнитель Примечание
Базовый (базовый класс) boolean, natural, integer, float, character, string, range, date, time, datetime, now
Изображение image, dataImage Адрес карты
Цвет (значение цвета) color шестнадцатеричная строка
Text paragraph, sentence, word, title, cparagraph, csentence, cword, ctitle абзацы, заголовки и т.
Name first, last, name, cfirst, clast, cname Имя, фамилия, заполнитель имени является представителем c на переднем плане для создания данных на китайском языке.
Web url, domain, email, ip, tld адрес, доменное имя, электронная почта, IP-адрес
Address area, region площадь, направление
Helper capitalize, upper, lower, pick, shuffle
Miscellaneous guid, id

Пример

экспорт

  • Закончив интерфейсный модуль, нажмите кнопку экспорта под панелью навигации, чтобы создать документ или скрипт, что очень удобно

возникшие проблемы

  1. При работе rap2 столкнулся с проблемой при входе на фронтенд страницу.При входе токен всегда был невалидным, и регистрация не реагировала.Позже я напрямую очистил таблицу Loggers в проекте rap2.

  2. После установки rap2 по умолчанию у mysql нет пароля, поэтому просто нажмите Enter при входе в систему.

    #进入mysql,直接回车
    docker exec -it docker_mysql mysql -uroot -p
    # 配置密码
    mysql> SET PASSWORD FOR 'root' = PASSWORD('new_password');
    
  3. Повторно разверните и измените конфигурацию, непосредственно измените файл docker-compose.yml для сохранения и повторно выполните шаг 5.