spring.boot.sapi.starter

Инструмент управления API на основе Spring Boot 2.x, простой инструмент вывода API.

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

Быстрый старт Quick start

1. Конфигурация удаленного репозитория

1.1 Maven

<dependency>
    <groupId>com.github.xiaour</groupId>
    <artifactId>xiaour.springboot.sapi.starter</artifactId>
    <version>1.4</version>
</dependency>

1.2 Gradle

implementation 'com.github.xiaour:xiaour.springboot.sapi.starter:1.4'

1.3 Дополнительные типы конфигураций репозиториев см. >>>

2. Добавление аннотации @Sapi в запускающий класс

Свойство controllers можно объявить многими, например controllers = {"com.example.demo.ctrl", "com.example.demo2.ctrl"}. Путь controllers соответствует пути контроллеров в проекте. enable — это переключатель SAPI, если требуется использовать его в продакшне, достаточно установить enable=false, чтобы избежать случайного раскрытия интерфейсов в продакшне.

@Sapi(controllers = {"com.example.demo.ctrl"})
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
```### 3. Добавление аннотации `@SapiGroup(title="")`
Аннотация `@SapiGroup` используется для группового вывода, где можно указать описание интерфейса на китайском языке. Эта аннотация является необязательной; если она не указана, по умолчанию будет использоваться имя текущего класса.
```java
@SapiGroup(title = "Название группы интерфейсов")
@RestController
@RequestMapping("/cat")
public class CatController {

}

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

2018-12-08 21:54:49.328  INFO 1112 --- [  restartedMain] c.g.x.a.config.ApiServerAutoConfigure    : SAPI страница url: http://127.0.0.1:8080/demo/sapi

Возможности версий

Текущая версия 1.4, реализует вывод URL выходных интерфейсов и параметров, а также группировку выходных интерфейсов;
Версия OnClickListener 2.0 будет включать добавление описаний интерфейсов и управления историческими версиями интерфейсов

Журнал обновлений

2018.06.28 Добавлена поддержка типов данных файловых.

2018.07.02 Добавлена поддержка пользовательских запросов Header.

2018.07.10 Добавлено пагинация интерфейсов.

2018.08.28 Улучшено форматирование возвращаемых результатов.

2018.09.07 Обновлен раздел отображения списков интерфейсов, исправлено сканирование Class.

2018.09.12 Добавлена поддержка RequestBody, добавлена поддержка MultipartFile для загрузки файлов.3 октября 2021 г. В @Sapi добавлен globalParams, добавлена поддержка глобальных header параметров, что позволяет реализовать функцию глобального токена.