springboot整合swagger的3步骤

本文介绍了如何将Swagger与SpringBoot整合,包括3个步骤:添加Swagger依赖,创建Swagger配置类,以及在启动类上添加注解。通过这些步骤,可以方便地为SpringBoot应用构建API文档。
摘要由CSDN通过智能技术生成

springboot整合swagger

1. 添加swagger依赖

 <!--整合swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.8.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.8.0</version>
        </dependency>

2. 添加swagger配置类

@Configuration
    public class Swagger2Configuration {
        /**
         * 对所有api扫描配置:controller路径
         */
        private static final String BASE_PACKAGE = "org.mm.controller";
        /**
         * Swagger2的配置文件
  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
您好,以下是springboot整合swagger2的步骤demo: 1. 在pom.xml文件中添加swagger2的依赖: ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> ``` 2. 创建Swagger2配置类,用于配置Swagger2相关信息: ``` @Configuration @EnableSwagger2 public class Swagger2Config { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot中使用Swagger2构建RESTful APIs") .description("更多Spring Boot相关文章请关注:http://www.example.com/") .termsOfServiceUrl("http://www.example.com/") .contact("example") .version("1.0") .build(); } } ``` 3. 在Controller类中添加Swagger2注解,用于描述接口信息: ``` @RestController @RequestMapping("/user") @Api(tags = "用户管理") public class UserController { @ApiOperation(value = "获取用户列表", notes = "获取所有用户列表") @GetMapping("/list") public List<User> list() { // ... } @ApiOperation(value = "创建用户", notes = "根据User对象创建用户") @ApiImplicitParam(name = "user", value = "用户实体", required = true, dataType = "User") @PostMapping("/create") public String create(@RequestBody User user) { // ... } @ApiOperation(value = "更新用户", notes = "根据User对象更新用户") @ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"), @ApiImplicitParam(name = "user", value = "用户实体", required = true, dataType = "User") }) @PutMapping("/update/{id}") public String update(@PathVariable Long id, @RequestBody User user) { // ... } @ApiOperation(value = "删除用户", notes = "根据ID删除用户") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") @DeleteMapping("/delete/{id}") public String delete(@PathVariable Long id) { // ... } } ``` 4. 启动应用程序,访问http://localhost:8080/swagger-ui.html,即可查看Swagger2生成的接口文档。 希望对您有所帮助!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值