Вам нужно управление интерфейсом?

Java

предисловие

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

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

Здесь в этой статье в основном будет рассказано о YApi, самой популярной платформе управления интерфейсом с открытым исходным кодом в Китае, и показано, как ее использовать, чтобы помочь нам повысить эффективность разработки и упростить управление интерфейсом.

В этой статье не будет описываться процесс установки и развертывания YApi. Чтобы узнать больше о том, как развернуть YApi, перейдите по справочной ссылке в конце статьи:Установка и развертывание YApi,Создание Yapi с помощью Docker

Введение в ЯПи

YApi — это локально развертываемая платформа управления визуальным интерфейсом, которая объединяет внешний и внутренний интерфейсы, а также контроль качества. Она направлена ​​на предоставление более элегантных услуг по управлению интерфейсом для разработчиков, продуктов и тестировщиков. команда Qunar.com, размещенная по адресуGithub, имеет более 9000 звезд.

Как платформа управления API, YApi в основном обеспечивает три основные функции:

  • Управление проектами: обеспечивает базовую группировку проектов, управление проектами, функции управления интерфейсом и управление правами участников.
  • Управление интерфейсом: предоставление удобных документов интерфейса, поддержка функций совместного редактирования интерфейса несколькими людьми и инструменты тестирования, подобные почтальонам, для эффективной отладки интерфейса.
  • Имитационный сервис: на основеMock.js, с помощью генерации случайных данных, моделируйте различные данные интерфейса и в полной мере используйте преимущества разделения интерфейса и сервера.

Что такое Мок.js

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

--- Дело о mock.js (Часть 1)

Конечно, YApi также имеет много мощных функций, таких как автоматическое тестирование, механизм плагинов, вторичная разработка и так далее.

На следующем рисунке показан рабочий процесс использования YApi, официально предоставленный YApi Отсюда вы можете просто понять, как использовать YApi в повседневной разработке.

Первый ЯПи

войти Зарегистрироваться

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

После успешной регистрации вы автоматически войдете на домашнюю страницу YApi, и вы сможете войти прямо под своей учетной записью, если воспользуетесь ею позже.

Следует отметить, что как вновь зарегистрированный пользователь у вас нет никаких разрешений для групп и проектов, и вы можете только искать и просматривать интерфейс «Общедоступных проектов».В настоящее время вам необходимо связаться с администратором платформы, чтобы добавить вас в соответствующий проект.

На следующем рисунке показано основное содержание входа на домашнюю страницу YApi с обычной учетной записью:

  1. В шапке домашней страницы отображается текущее местоположение, окно поиска, новый проект, просмотр документов и информация о пользователе.

  2. Информация о группе отображается в левой части главной страницы. «Группа» — это набор «проектов», и только суперадминистраторы могут управлять группами.

  3. В правой части домашней страницы находится список проектов и участников группы.Нажмите на группу слева, и информация о проекте и участниках группы появится справа.

  4. Нажмите на звездочку в правом верхнем углу проекта, чтобы подписаться на проект, и проект, на который вы подписаны, можно просмотреть на странице «Мои подписки».

  5. Нажмите на аватарку, чтобы войти в «Личный центр», позволяющий просматривать и изменять личную информацию.

Интерфейс проекта

Сначала выберите элемент в списке элементов для ввода (если ни один элемент не доступен,Один из способов — попросить администратора назначить права доступа к проекту., один из них - щелкнуть в верхнем левом углу"Добавьте предмет"Создаем новый проект), после входа в проект можно примерно увидеть следующее содержимое:

image-20190702224455234

  1. В списке интерфейсов отображаются все имена интерфейсов проекта, и они классифицируются в соответствии с папкой.По умолчанию все они находятся в общедоступной категории, и вы также можете добавить пользовательские категории.
  2. Набор тестов используется для сохранения информации о данных и состоянии интерфейса при нормальной работе интерфейса, чтобы тесты интерфейса в наборе тестов можно было напрямую использовать в будущем.
  3. Добавить интерфейс, добавить интерфейс в проект.По умолчанию он находится в категории public.Необходимо указать имя интерфейса,метод запроса и путь к интерфейсу.После сохранения он будет автоматически добавлен в список интерфейсов.
  4. Он используется для импорта и экспорта данных интерфейса, что удобно для переноса и архивирования данных интерфейса.
  5. Основные настройки для информации о проекте, такие как адрес среды, путь к интерфейсу, настройки Mock и т. д.

Теперь давайте посмотрим на содержимое отображения страницы следующего простого интерфейса:

WechatIMG908

В окне информации об интерфейсе есть четыре панели, которые можно переключать: «Предварительный просмотр», «Редактирование», «Выполнить» и «Расширенный макет».редактироватьВ панели можно отредактировать метод запроса интерфейса, данные запроса, данные ответа, описание интерфейса и другую информацию, после сохранения она будет впредварительный просмотрОн четко отображается на панели, когда требуется тестирование интерфейса, его нужнобегатьРабота в панели очень похожа на Postman, я считаю, что друзья, которые использовали Postman, смогут быстро начать работу.

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

Вот небольшая хитрость: каждый раз, когда вы входите в рабочую панель интерфейса, последний раз, когда вы использовали параметры запроса, будет влиять, и вам нужно каждый раз заново заполнять.Если слишком много параметров интерфейса запроса, это будет очень громоздко, здесь мы можем протестировать интерфейс черезспастиКнопка добавляется в тестовый набор, а записанный интерфейс и действительные параметры запроса можно найти непосредственно в тестовом наборе и использовать напрямую.

image-20190704082517792

Столбец Advanced Mock — это настройка данных моделирования интерфейса, конкретное использование будет подробно описано позже.

На этом этапе было представлено простое использование YApi. Использование YApi для базового тестирования и обслуживания интерфейса не должно быть проблемой. Более расширенное использование и лучшие практики YApi будут представлены позже.

Макет интерфейса

В этом разделе в основном описывается, как имитировать данные интерфейса с помощью сервиса Mock YApi.

Сначала выберите в панели интерфейсаРасширенный макетвыберите «Добавить ожидания», чтобы определить условия и данные для реализации моделирования.

image-20190706151957646

При добавлении ожиданий он делится на две части.Одна предназначена для заполнения основной информации об ожидании, такой как имя, IP-адрес в белом списке, соответствующие параметры и т. д., а другая — данные ответа, которые, как ожидается, будут смоделированы. такие как информация заголовка ответа, данные тела ответа и даже время ответа.

При настройке данных тела ответа здесь, помимо использования обычных фиксированных поддельных данных для возврата, мы можем использовать синтаксис, поддерживаемый Mock.js, для случайного создания поддельных данных.Например, следующий пример имитирует простые данные ответа:code200 или 400,messageПовторите тест дважды от 1 до 10 раз.

image-20190706152640885
После сохранения мы случайным образом получаем следующие данные запроса, делая несколько запросов к фиктивному адресу интерфейса* (ссылка фиктивного адреса в панели предварительного просмотра)*:

{
"code": 200,
"message": "测试测试测试",
"data": {}
}

{
"code": 400,
"message": "测试测试测试测试测试测试",
"data": {}
}

Конечно, в дополнение к определению генерации фиктивных данных таким образом, существует множество расширенных форм.Синтаксис определения конкретных данных см. в официальном примере, предоставленном Mock.js:mocktech.com/examples.contracts…

Лучшие практики

Классификация интерфейсов

YApi управляет интерфейсами в единицах проектов.На основе функции классификации, предоставляемой этим, вновь созданные интерфейсы по умолчанию классифицируются как общедоступные.

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

image-20190706163548920

Конфигурация среды

Когда программа в ежедневной разработке будет иметь разные требования к среде, адрес запроса интерфейса также будет другим.Чтобы облегчить переключение интерфейсов с несколькими средами, мы можем установить环境配置Множество окружений, которые добавляют интерфейс под проект, а здесь добавляются глобальныеheaderУстановите глобальный проектheaderценность.

image-20190706154822768

В дополнение к этому пользователь может определить в каждом элементе конфигурации средыglobalИмя и значение глобальной переменной, которую можно передать через операцию интерфейса или набор тестов.{{ global.Name }}для доступа к глобальным переменным, определенным в текущей переменной среды.

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

image-20190706155307573

запросить конфигурацию

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

Расположение запрошенной конфигурации также находится в настройках проекта, которые действуют для всех интерфейсов проекта и предоставляют общедоступные переменные для внешнего мира.contextОбъект содержит все данные для запроса и ответа.

image-20190706162341811

Если нам нужно добавить публичный URL для набора интерфейсовtokenПараметры, в Pre-request Script можно написать следующий скрипт:

carbon

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

carbon

Кроме того, глобальные переменныеcontextТакже предоставляет служебные функции, давайте использовать:

工具函数

В сочетании с инструментальными функциями мы можем выполнять шифрование во время запроса интерфейса и ответа, например, нам нужно зашифровать тело ответа.dataДанные передаются следующему скрипту:

carbon

Импорт и экспорт данных

Что касается управления данными, YAPI предоставляет простое и эффективное решение для поддержки импорта и экспорта данных.

YApi поддерживает быстрый импорт данных интерфейса в других форматах для облегчения быстрого добавления интерфейсов. В настоящее время YApi поддерживает импорт данных Postman, Swagger, JSON и т. д., что нам удобно для переноса данных интерфейса.

Когда нам нужно поделиться интерфейсом с людьми, которые не входят в группу проекта, мы можем использовать функцию экспорта данных, чтобы экспортировать данные документа интерфейса проекта в формате HTML, Markdown или JSON, и нам нужно только передать файл документа другим.

Эпилог

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

Ссылаться на

Рекомендуемое чтение

Категории