swagger-mг-ui

Проект

swagger-mг-ui — это реализация фронтенда для Swagger с простым использованием, быстрой скоростью парсинга и продуманным дизайном, что обеспечивает вам незабываемый опыт!

Поставьте лайк, чтобы поддержать проект! Это мотивирует автора на регулярные обновления. В правом верхнем углу ↗

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

1. Добавление зависимости

<!-- https://mvnrepository.com/artifact/com.zyplayer/swagger-mg-ui -->
<dependency>
    <groupId>com.zyplayer</groupId>
    <artifactId>swagger-mg-ui</artifactId>
    <version>2.0.0</version>
</dependency>

2. После запуска переходите по адресу: http://localhost:8080/document.html — проектный адрес + document.html

Почему стоит заново создать колесо?

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

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

   В этом проекте версия 1.x была создана с использованием jQuery. После обучения работе с Vue потерял интерес к поддержанию этого проекта, поэтому использовал Vue3 + Ant-design-vue для создания версии 2.x. После переформатирования чувствую себя свежо и бодро. Каждая строчка нового кода написана заново, скорость парсинга увеличилась, логика стала более понятной, код стал проще и чище, дизайн — приятнее.2. Есть пользователи, которым требуется только красивый UI.

2. Новые технологии всегда так привлекательны, что невозможно устоять перед желанием попробовать их.

Какие возможности предоставляет этот проект?

Версия 2.x представляет собой только фронтенд UI без какого-либо кода backend, чтобы удовлетворить потребность в одном красивом UI. Больше унифицированных функций управления документами перемещены в проект zyplayer-doc, если вас заинтересует эта тема, рекомендуем обратиться туда.

Нужно ли всё или достаточно?

Провёл детальное исследование стандарта Swagger https://swagger.io/specification/v2, в котором присутствуют множество свойств. Если следовать стандарту до конца, то многие из этих свойств могут оказаться ненужными, а тестирование станет сложным и труднодостижимым.

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

Если вы столкнулись с какой-либо проблемой, которая вас беспокоит, вы можете создать issue, решение будет найдено и выпущено максимум за неделю.Если вам понравился этот проект, продолжайте его поддерживать и предлагайте свои идеи, чтобы он развивался дальше.#### Архитектура программного обеспечения Используемые зависимости на стороне клиента: Vue3, vue-router, vuex, ant-design-vue, axios, brace, highlight.js, jsontoxml, less, mavon-editor, moment, qs, sass, xml-formatter, ...Приветствуем вас в чате для обсуждений:

Скриншоты интерфейса

Главная страница

Страница просмотра документов

Страница онлайн-отладки