swagger使用

最新推荐文章于 2024-04-17 10:09:34 发布

原创最新推荐文章于 2024-04-17 10:09:34 发布 · 174 阅读

CC 4.0 BY-SA版权

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


config下：


public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xx.project.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("项目名称")
                        .description("描述")
                        .version("1.0")
                        .build());
    }
}

controller整体

@Api(tags = "xx")

方法上

@ApiOperation("xx")

@ApiImplicitParams({

@ApiImplicitParam(name = "xxId", value = "id", required = true, paramType = "query", dataType = "integer"),

@ApiImplicitParam(name="xxName", value = "名称",required = true,paramType = "query", dataType = " string"),

})

@RequestMapping(value = "/xxxx", method = {RequestMethod.POST, RequestMethod.GET})