Swagger 规范接口的 UI

• Основной акцент сделан на читаемость документации, предоставление интерфейса документа для вызывающего абонента, что позволяет избежать необходимости написания документа.
• Этот проект не имеет аналогичной официальной онлайн-функции тестирования/отладки, рекомендуется использовать Postman, который по умолчанию поддерживает импорт интерфейсов, соответствующих спецификации swagger. Однако структура папок не соответствует структуре документа, поэтому была реализована функция экспорта в Postman.
• Онлайн-пример.
• Журнал обновлений.

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

Интеграция с springfox framework

1. Удалите зависимость официального пользовательского интерфейса:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${springfox.version}</version>
</dependency>

2. Добавьте зависимость swagger-document-UI:

<dependency>
    <groupId>cn.javaer.springfox</groupId>
    <artifactId>swagger-document-ui</artifactId>
    <version>1.0.2</version>
</dependency>

Spring Boot интеграция

Интеграция с Spring Boot является самым простым способом использования. Рекомендуется использовать интеграцию, предоставляемую программистом DD/spring-boot-starter-swagger, а затем вам необходимо:

1. Исключить встроенную зависимость пользовательского интерфейса:

<dependency>
    <groupId>com.spring4all</groupId>
    <artifactId>swagger-spring-boot-starter</artifactId>
    <version>${swagger-spring-boot-starter.version}</version>
    <!--Исключение встроенной зависимости пользовательского интерфейса-->
    <exclusions>
        <exclusion>
            <artifactId>springfox-swagger-ui</artifactId>
            <groupId>io.springfox</groupId>
        </exclusion>
    </exclusions>
</dependency>

2. Добавить зависимость swagger-document-UI:

<dependency>
    <groupId>cn.javaer.springfox</groupId>
    <artifactId>swagger-document-ui</artifactId>
    <version>1.0.2</version>
</dependency>

Развёртывание статических ресурсов

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

1. Он запросит /swagger-resources (адрес по умолчанию для springfox) и /swagger-resources.json (новый адрес этого проекта), чтобы получить адрес интерфейса API информации.
2. Запрос swagger-resources, который настроен в url (приоритет) или location (совместимый со старой версией, которая не предоставляет поле url), должен возвращать интерфейс API информации, соответствующий спецификации swagger, чтобы его можно было использовать.
3. Вы можете обратиться к способу развёртывания онлайн-примера, ветвь: online-demo.

Эффект предварительного просмотра

Навигация по якорным точкам справа от документа

Выбор группы API

Нечёткое соответствие

• Поддерживает китайский язык, пиньинь и английский язык.
• Можно искать имя API, название категории, путь URL.

Экспорт в Postman