SpringBoot интегрирует Swagger3 — онлайн-документацию по API (подробные шаги + диаграммы)

Java

Open API

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

Swagger

Swagger — это организация по обслуживанию документов API, а позже стала основным разработчиком стандарта Open API.Теперь последняя версия — Swagger3 (Open Api3), выпущенная в 2017 году. Большинство людей в Китае до сих пор используют устаревший swagger2 (прекращение обслуживания в 2017 году и изменение названия на swagger3).Имя пакета swagger2 — io.swagger, а имя пакета swagger3 — io.swagger.core.v3. 

В этой статье вы узнаете, как интегрировать Swagger3, выполнив несколько простых шагов.

  • Добавьте зависимости Swagger3 в файл pom проекта.

        <!--Swagger3-->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-boot-starter</artifactId>
        <version>3.0.0</version>
    </dependency>

  • Добавьте аннотацию @EnableOpenApi в класс запуска SpringBoot, чтобы включить Swagger3.

    @SpringBootApplication @EnableOpenApi public class DemoAllApplication {

    public static void main(String[] args) {
    SpringApplication.run(DemoAllApplication.class, args);
}

    }

  • Добавьте пользовательский класс конфигурации Swagger3 (необязательно)

    @Configuration public class Swagger3Config { @Bean public Docket createRestApi() { return new Docket(DocumentationType.OAS_30) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) .paths(PathSelectors.any()) .build(); }

    private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Swagger3接口文档")
            .description("欢迎关注公众号：撸码社区")
            .contact(new Contact("撸码社区", "http://localhost:8080/swagger-ui/index.html", "ctw17680251029@163.com"))
            .version("1.0")
            .build();
}

    }

  • Добавьте комментарии, связанные со Swagger, к контроллеру

    @Api(tags = "Контроллер --Hello") @RequestMapping("/привет") @RestController открытый класс HelloController {

    @PostMapping("/insert")
@ApiOperation("新增方法--insert")
public String insert() {
    return "insert";
}

@PutMapping("/update")
@ApiOperation("修改方法--update")
public String update() {
    return "update";
}

@DeleteMapping("/delete")
@ApiOperation("删除方法--delete")
public String delete() {
    return "delete";
}

@GetMapping("/getAll")
@ApiOperation("查询方法--getAll")
public String getAll() {
    return "getAll";
}

    }

  • Чтобы начать проект, посетите:http://localhost:8080/swagger-ui/index.html 

在这里插入图片描述

  • Добавьте поддержку bootstrap-ui, добавьте зависимость swagger-bootstrap-ui (необязательно)

        <!--swagger-bootstrap-ui-->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>swagger-bootstrap-ui</artifactId>
        <version>1.9.6</version>
    </dependency>

  • Чтобы начать проект, посетите:http://localhost:8080/doc.html(по желанию)

在这里插入图片描述

Связанные примечания:

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · div（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性

Вот и все шаги! Очень просто и практично! Надеюсь, вам всем понравится!

Если у вас есть какие-либо вопросы, пожалуйста, задавайте их в разделе комментариев! Пожалуйста, лайк! Вперед, пожалуйста! Спросите о коллекции!

Категории