Система управления интерфейсом Lilac Garden с открытым исходным кодом - API Mocker

JavaScript API

API Mocker

Сначала вставьте адрес проекта:DXY-F2E/api-mocker

С развитием Интернета и эволюцией разделения внешнего и внутреннего интерфейса взаимодействие веб-страниц становится все более и более сложным. В процессе разработки проекта, когда фронт и бэкенд разрабатываются параллельно, в части, связанной с интерфейсом, всегда возникают различные проблемы. Такие как поддельные данные интерфейса, соглашение о параметрах интерфейса, отладка прокси и т. Д., Сильно влияют на эффективность разработки.

API Mocker стремится решать различные проблемы в процессе совместной разработки интерфейсов и серверов, повышать эффективность разработки, унифицировать управление интерфейсами и предоставлять более удобный способ последующего итеративного обслуживания.

Системные функции

Соглашения об интерфейсе

API Mocker обеспечивает простое в использовании, но многофункциональное редактирование интерфейса, а подрядчики по интерфейсу могут легко устанавливать различную информацию об интерфейсе, в том числе:

  • Ввод и вывод параметров структурированного интерфейса
    • Поддерживает соглашения о параметрах запроса различных размеров (query,body,path, header)
    • Соглашения о типах, которые поддерживают параметры (string,number,boolean,object,array)
    • Примечания к параметрам, примеры
  • Поддерживает обратную генерацию структур параметров из данных Json.
  • Сохраняйте определенную историю интерфейса

Имитация данных

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

  • Мок-запросы автоматически генерируют поддельные данные в соответствии с соглашением об интерфейсе.
  • Запрос Mock проверит параметры запроса в соответствии с соглашением об интерфейсе. (Проверьте, является ли он необязательным и правильный ли тип параметра).
  • В соответствии с соглашением об интерфейсе и пользовательскими настройками он может имитировать различные состояния ответа сети, такие как:200,404,500.
  • Поддержка прокси-сервера интерфейса, фиктивный запрос прокси-сервера на онлайн- или тестовый адрес, избегание междоменной среды разработки и сохранение процесса прокси-сервера Charles.
  • служба поддержкиMock.jsграмматика.

документация по интерфейсу

API Mocker автоматически создаст краткие, красивые и хорошо структурированные документы интерфейса в соответствии с соглашениями об интерфейсе. При этом вы можете подписаться на интерфейс и своевременно получать уведомления по электронной почте при изменении интерфейса.

Разрешения интерфейса

API Mocker обеспечивает простой в использовании контроль разрешений.

  • Уровень группы, управление на уровне API
  • Видимость, контроль разрешений на запись

Другие функциональные точки

  • Тестирование интерфейса. Разработчики могут напрямую протестировать интерфейс в системе, чтобы не заполнять многие параметры по запросу такими инструментами, как почтальон.
  • Удобный интерфейс поиска. (Вы можете искать интерфейсы по адресу интерфейса, администратору и т.д.)
  • представление данных
  • Поддержка для импорта рэпа

Технологические стеки и сторонние библиотеки

  • ES6
  • ESLint (Standard)
  • Ramda
  • ...

Client

  • VueСемейное ведро (vue + vuex + vue-router + webpack)
  • ElementUI, Mock.js, etc...
  • Less

Схема архитектуры выглядит следующим образом:

Server

Схема архитектуры выглядит следующим образом:

Для другого контента, связанного с развертыванием, см. введение адреса проекта на github.

Перспективы системы в будущем

Более мощные соглашения об интерфейсе

  • Добавьте больше атрибутов проверки (дата, диапазон, регулярный)
  • более удобное редактирование
    • Выбор шаблона
    • Интеллектуальная подсказка для полей интерфейса в группах
    • Улучшить поддержку restful API
  • Управление статусом интерфейса, управление версиями

Более полные периферийные функции

  • чванливый импорт
  • Экспорт документа в формате уценки
  • Экспорт файла модели (TypeScript и т. д.)
  • автоматизированный тест
    • случайные данные
    • несколько запросов
    • Создание отчетов

Другие идеальные точки

  • Улучшить фиктивный опыт
  • Статистика большего количества параметров
  • Улучшить документацию
  • глобализация

Спасибо

Сам проект также ссылается на многие проекты с открытым исходным кодом, и я хотел бы еще раз поблагодарить эти проекты за их выдающийся вклад в социальные и технологические круги. Lilac Garden также будет усердно работать и продолжать выпускать техническую продукцию и продукты, а также вносить свой вклад в сообщество открытого исходного кода.

адрес гитхаба     Документация по использованию API Mocker