Swagger2的接口配置

搭配依赖 
<swagger.version>2.9.2</swagger.version


/**
 * Swagger2的接口配置
 * 
 * @author guquanyou
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig
{
    /**
     * 创建API
     */
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                // 用来创建该API的基本信息,展示在文档的页面中(自定义展示的信息)
                .apiInfo(apiInfo())
                // 设置哪些接口暴露给Swagger展示
                .select()
                // 扫描所有有注解的api,用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 扫描指定包中的swagger注解
                //.apis(RequestHandlerSelectors.basePackage("com.ruoyi.project.tool.swagger"))
                // 扫描所有 .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo()
    {
        // 用ApiInfoBuilder进行定制
        return new ApiInfoBuilder()
                // 设置标题
                .title("标题:若依管理系统_接口文档")
                // 描述
                .description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")
                // 作者信息
                .contact(new Contact(Global.getName(), null, null))
                // 版本
                .version("版本号:" + Global.getVersion())
                .build();
    }
}
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger2是一个用于生成API文档的工具,可以方便地展示Web服务的接口文档,下面是Swagger2在Java项目中的配置步骤: 1. 引入Swagger2依赖 在项目的pom.xml文件中添加以下依赖: ```xml <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> ``` 2. 配置Swagger2 在Spring Boot项目的启动类或者@Configuration配置类中,添加以下配置: ```java @Configuration @EnableSwagger2 // 开启Swagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) // 扫描指定包下的Controller .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("XXX项目API文档") .description("XXX项目的API文档") .version("1.0") .build(); } } ``` 其中,Docket是Swagger2的配置类,apiInfo()方法用于配置API文档信息,createRestApi()方法用于指定扫描的Controller所在的包路径。 3. 添加API文档注解 在需要生成API文档的Controller方法上,添加相应的注解,例如: ```java @RestController @RequestMapping("/user") @Api(tags = "用户管理相关接口") public class UserController { @ApiOperation("获取用户列表") @GetMapping("/list") public List<User> list() { // ... } @ApiOperation("添加用户") @PostMapping("/add") public void add(@RequestBody User user) { // ... } } ``` 其中,@Api注解用于指定接口所属的标签,@ApiOperation注解用于指定接口的描述信息。 4. 查看API文档 在项目启动后,访问http://localhost:port/swagger-ui.html即可查看API文档。在文档页面中,可以查看接口的详细信息、请求参数、响应信息等。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值