OSCHINA-MIRROR/jiangww007-swaggerLUI

SwaggerLUI — это открытый инструмент для отладки интерфейсов и управления документацией, основанный на расширении Swagger. Он использует технологии Spring Boot и Layui. Поддерживает только проекты с аннотациями Swagger.

Введение

Интерфейс Swagger неудобен в использовании;
Некоторые функции отладки интерфейса реализованы не лучшим образом, например, загрузка и скачивание;
Управление документацией некоторых проектов слишком сложное и разрозненное, хотелось бы, чтобы оно было более удобным и сопровождало интерфейс;
Отладка интерфейса и управление документацией вместе работают лучше в режиме разделения переднего и заднего плана;
По этим причинам был создан новый инструмент, которым можно поделиться с другими пользователями.

Особенности

Можно настроить собственный адрес доступа к интерфейсу, независимо от проекта;
Также можно легко интегрировать его в проект и упаковать в один jar-файл;
Удобная функция отладки интерфейса поддерживает множество сложных параметров;
Хороший интерфейс документации позволяет просматривать сложные входные и выходные параметры, что делает режим разделения переднего и заднего планов более дружественным;
Поддерживается отладка загрузки и скачивания через POST, и этот список будет продолжать расширяться;
Можно управлять пользовательскими документами MD в этом инструменте отладки интерфейса.

Цель

Удобство отладки интерфейса;
Единое управление и просмотр документации в режиме разделения переднего и заднего планов;
Желание сделать процесс разработки более стандартизированным.

Адрес демонстрации проекта

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

Обратите внимание, что при первом входе необходимо установить адрес доступа к интерфейсу: http://49.233.23.145:7777/.

Архитектура программного обеспечения

Spring Boot + Layui

Инструкция по установке

Скачайте SwaggerLUI и упакуйте его в jar-файл.
Включите зависимость упакованного jar-файла в нужный проект.

   <dependency>
   	<groupId>com.swagger.lui</groupId>
   	<artifactId>swaggerLUI</artifactId>
   	<version>0.0.1-SNAPSHOT</version>
   </dependency>

Настройте информацию о данных в вашем собственном проекте, обычно в файле application.properties.

   С использованием базы данных H2:
   swlui.driver=org.h2.Driver
   адрес базы данных h2: d:/h2/swluidbtest (адрес и имя базы данных должны быть настроены самостоятельно)
   swlui.url=jdbc:h2:d:/h2/swluidbtest
   имя пользователя базы данных h2 настроено произвольно
   swlui.username=root
   пароль базы данных h2 настроен произвольно
   swlui.password=123456

Добавьте сканирование пакетов в класс запуска:

@ComponentScan(basePackages = { "com.swagger.lui" })

Добавьте следующий код в WebMvcConfig:

 @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger_lui_index.html").addResourceLocations("classpath:/swagger/doc/");
        registry.addResourceHandler("/**").addResourceLocations("classpath:/swagger/lui/");
        super.addResourceHandlers(registry);
    }

Запустите: http://ip+порт+/swagger_lui_index.html например: http://localhost:8088/swagger_lui_index.html.
Не будем приводить скриншоты интерфейса, пожалуйста, посетите демонстрационный проект для ознакомления.

Использование

Настройка системы При первом использовании необходимо запустить «систему инициализации», удалить таблицы и базу данных и создать их заново. Обратите внимание, что эта операция удалит информацию о пользовательских документах, которую невозможно восстановить.
Глобальная настройка параметров В процессе отладки можно настроить некоторые часто используемые параметры для удобства отладки.
Управление документами MD Управление пользовательскими документами MD, которые могут быть написаны для собственных проектов, таких как стандарты разработки, примечания и т. д., для удобного просмотра, обмена и обслуживания.

Пример использования демонстрационного проекта

Загрузите swaggerLUIDEMO-0.0.1-SNAPSHOT.jar.
Запустите java -jar swaggerLUIDEMO-0.0.1-SNAPSHOT.jar --server.port=7777.
Запустите http://localhost:7777/swagger_lui_index.html.
При первом запуске может возникнуть ошибка, не обращайте на неё внимания, это связано с тем, что база данных не была инициализирована.
Установите адрес доступа к интерфейсу: http://localhost:7777/.
Запустите «кнопку инициализации системы», затем вы можете перейти в «управление документами MD».

Участие в разработке

Лицензия

Лицензия Apache 2.0