在弹簧靴项目上设置Swagger Springfox
#java #springboot #swagger

Swagger是一种软件工具,可让我们以幻想和标准化的方式记录API。 Springfox是一个可以与Spring Boot集成的库,可以使用Swagger生成API文档。

这是在Spring Boot项目上配置Swagger Springfox的步骤:

添加必要的依赖

第一步是将必要的依赖性添加到pom.xml文件(如果是Maven项目)或已构建的gradle(对于Gradle Projects)。依赖是:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

配置o招牌

接下来,有必要在其Spring Boot应用程序中设置Swagger。这可以通过使用koud0创建一类配置来完成:
注释注意

@Configuration
@EnableSwagger2
public class SwaggerConfig {    
    @Bean
    public Docket api() { 
        return new Docket(DocumentationType.SWAGGER_2)  
          .select() 
          .apis(RequestHandlerSelectors.any())              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}

DiCket类用于配置Swagger选项,例如API和要记录的端点。

写下控制器

最后,有必要用适当的Swagger音符写下API控制器。例如:

@RestController
@RequestMapping("/api")
@Api(value = "API de exemplo", description = "Exemplo de API com Swagger")
public class ExemploController {
    @ApiOperation(value = "Exemplo de endpoint", response = String.class)
    @GetMapping("/exemplo")
    public String exemplo() {
        return "Exemplo de API com Swagger";
    }
}

@Api Note用于定义API的值和描述,而@ApiOperation Note用于定义EndInt的响应的值和类型。

通过这些步骤,必须配置Swagger SpringFox并准备在其应用程序应用程序中使用。要访问Swagger用户界面,只需访问Koud3 URL,其中Koud4是执行其应用程序应用程序的门。