swagger的用法

最新推荐文章于 2025-02-17 23:34:54 发布

小孩与狗

最新推荐文章于 2025-02-17 23:34:54 发布

阅读量228

点赞数

分类专栏：常用工具文章标签： swagger2

本文链接：https://blog.csdn.net/weixin_44722917/article/details/115353249

版权

常用工具专栏收录该内容

6 篇文章

订阅专栏

本文介绍了如何在Spring Boot应用中集成Springfox Swagger，包括依赖引入、配置启动类、Swagger2Configuration设置，以及使用@Api注解展示API接口。通过访问swagger-ui.html，展示了如何生成详细的API文档。

摘要由CSDN通过智能技术生成

导入依赖

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

配置启动类

@SpringBootApplication
@EnableDiscoveryClient
@MapperScan("com.bajie.user.mapper")
@EnableSwagger2
public class UserServiceApp {
    public static void main(String[] args) {
        SpringApplication.run(UserServiceApp.class,args);
    }
}

配置配置文件

@Configuration
public class Swagger2Configuration {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bajie"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("八戒api文档")
                .description("八戒api文档")
//                .termsOfServiceUrl("/")
                .version("1.0")
                .build();
    }
}

使用

@RestController
@RequestMapping
@Api(value="bajie用户管理接口",description = "bajie用户管理接口，提供页面的增、删、改、查")
public class UserController {
    @Autowired
    private UserService userService;

    @GetMapping("check/{data}/{type}")
    @ApiOperation("分页查询页面列表")
    @ApiImplicitParams({
            @ApiImplicitParam(name="data",value = "数据",required=true,paramType="path",dataType="int"),
            @ApiImplicitParam(name="type",value = "类型",required=true,paramType="path",dataType="int")
    })
    public ResponseEntity<Boolean> checkUserData(@PathVariable("data") String data, @PathVariable(value = "type",required = true) Integer type) {
        Boolean boo = this.userService.checkData(data, type);
        if (boo == null) {
            return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
        }
        return ResponseEntity.ok(boo);
    }
}

访问http://localhost:25000/swagger-ui.html