🏆Эта статья включена в 《Spring Загрузка из входа в мастер》 ,Улучшение индекса специализированной атаки,2023 Самая системная и мощная система в Китае в 2017 году (в стадии обновления).

Эта колонка посвящена созданию самой сложной серии обучающего контента Spring Boot от нулевого уровня до продвинутого уровня. 🚀Все они запускаются исключительно во всей сети для создания качественных колонок... Колонка постоянно обновляется... Добро пожаловать всем. подписывайтесь и продолжайте учиться.

Описание среды: Windows10 + Idea2021.3.2 + Jdk1.8 + SpringBoot 2.3.1.RELEASE

Предисловие

При использовании Swagger для написания документации API мы неизбежно столкнемся с некоторыми узкими местами в Swagger. Например, пользовательский интерфейс Swagger не очень дружелюбен, стиль монотонный и некрасивый, а интерактивность не очень хорошая. Чтобы решить эти проблемы, мы можем использовать Knife4j для интеграции Spring Boot, чтобы украсить и расширить использование Swagger.

В этой статье будет рассказано, как использовать Knife4j для интеграции Spring Boot, а также дано краткое введение в использование Knife4j.

краткое содержание

Knife4j — это расширенная платформа пользовательского интерфейса, основанная на пользовательском интерфейсе Swagger, которая позволяет легко использовать Swagger для управления документами API и их тестирования. Spring Boot — это среда быстрой разработки, которая может упростить процесс разработки. Интеграция Knife4j со Spring Boot может упростить разработчикам управление документами API и их тестирование.

Эта статья будет разделена на следующие части:

1. Кратко опишите Swagger и Knife4j;
2. Шаги по интеграции Knife4j с Spring Boot;
3. Введение в использование Knife4j;
4. тестовые случаи;
5. Краткое изложение полного текста.

текст

1. Краткое введение в Swagger и Knife4j.

Swagger — это платформа с открытым исходным кодом для написания документации API. Это может помочь нам отображать документы API в Интернете через пользовательский интерфейс Swagger, тем самым обеспечивая визуальное управление документами API.

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

Knife4j — это расширенная версия Swagger-UI. Она улучшена и оптимизирована на основе Swagger-UI, обеспечивая более полный интерактивный интерфейс и более красивый дизайн пользовательского интерфейса. В то же время он также предоставляет более расширенные функции, такие как онлайн-отладка и многоязычная поддержка.

2. Шаги по интеграции Knife4j с Spring Boot

Ниже мы расскажем, как интегрировать Knife4j в Spring Boot.

2.1 Настройка файла pom.xml

Добавьте следующие зависимости в файл pom.xml проекта:

<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>knife4j-spring-boot-starter</artifactId>
	<version>${latest.version}</version>
</dependency>

в,${latest.version}это номер последней версии。

2.2 Настройка Swagger и Knife4j

Весной Bootфайл конфигурацииapplication.propertiesДобавьте следующую конфигурацию в：

# Конфигурация Swagger
swagger.enabled=true

# Конфигурация Knife4j
knife4j.swagger-ui.enabled=true
knife4j.swagger-ui.path=/doc.html

в,swagger.enabledУказывает, включать лиSwagger,knife4j.swagger-ui.enabledУказывает, включать лиKnife4j,knife4j.swagger-ui.pathвыражатьKnife4jпуть доступа。

2.3 Написание документации API

Используйте аннотации Swagger для написания документации API.

@RestController
@RequestMapping("/api/user")
@Api(tags = {"Управление пользователями"})
public class UserController {

    @GetMapping("/{id}")
    @ApiOperation(value = «Получить информацию о пользователе», notes = «Получить информацию о пользователе на основе идентификатора пользователя»)
    public User getUser(@PathVariable Integer id) {
        return userService.getUserById(id);
    }

    @PutMapping
    @ApiOperation(value = «Обновить информацию о пользователе», notes = «Обновление информации о пользователе на основе входящей информации о пользователе»)
    public User updateUser(@RequestBody User user) {
        return userService.updateUser(user);
    }

3. Введение в использование Knife4j

3.1 Интерфейс пользовательского интерфейса Knife4j

Начало весны Bootприложение,доступhttp://localhost:8080/doc.html,можно увидеть Интерфейс пользовательского интерфейса Knife4j。 Примеры следующие:

3.2 Функция онлайн-отладки Knife4j

В интерфейсе пользовательского интерфейса Knife4j мы можем напрямую выполнять онлайн-отладку API. Например, мы можем щелкнуть вкладку «Управление пользователями» выше, выбрать интерфейс «Получить информацию о пользователе» и ввести параметры для тестирования. Примеры следующие:

Имитировать отправку запроса:

3.3 Многоязычная поддержка Knife4j

Knife4j поддерживает многие часто используемые языки.,Например китайский、Английский、японский и т. д.。Мы можем установить это в файле конфигурацииknife4j.swagger-ui.languageСвойства для настройки языка。

knife4j.swagger-ui.language=zh-CN

4. Тестовые случаи

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

5. Краткое изложение полного текста

В этой статье рассказывается, как использовать Knife4j для интеграции Spring Boot, и дается краткое введение в Knife4j. Используя Knife4j, мы можем украсить и улучшить документы API, а также улучшить интерактивность и читабельность документов API.

я участвуюВторой этап специального тренировочного лагеря Tencent Technology Creation 2023 года включает в себя эссе, получившие призы, которые разделят призовой фонд в 10 000 юаней и часы с клавиатурой.