端点按资源大笔标注进行分组? [英] endpoints group by resources swagger annotation?

问题描述

我正在使用Spring进行REST API开发.我有一些端点很多的API.当我打开swagger ui时，它看起来已经装满了.

我刚刚阅读了

********** 解决方案2 :(使用标签) ********

您不需要定义多个 Docket bean，只需定义一个即可.

  @Bean公共案卷api1(){//这里的标记是可选的，它只是在用户界面中添加描述//默认情况下，描述为类名，因此，如果您使用//在不同的类上使用@@ Api，它将选择其中一个类名作为//说明，因此最好为它们定义自己的说明返回新的Docket(DocumentationType.SWAGGER_2).tags(new Tag("users"，"users related")，新标签(产品"，相关产品")).选择().apis(RequestHandlerSelectors.basePackage("com.github")).建造();} 

此后，您只需要使用 @Api (在类级别，所有方法的默认值)或 @ApiOperation (在方法级别，将覆盖)来注释您的api方法值).

  @RestController@RequestMapping("/api/products")@Api(标签=产品")公共类ProductController {@ApiOperation(值="，标签=产品")@RequestMapping(方法= RequestMethod.POST)@ResponseStatus(HttpStatus.CREATED)公开产品createProduct(@RequestBody产品产品){退货；}} 

@ApiOperation (或 @Api )中的

标签也将跨控制器工作，即使用给定标签标记的不同控制器类(或控制器本身)中的方法将被分组在一起.

I'm using Spring for my REST API development. And I have some API where there are lots of endpoints. When I open up swagger ui, it looks to packed.

I just read this article and saw that we can group endpoints based on resource level.

I just want to know how that can be achieved with swagger annotations with Spring. I appreciate if someone can describe with an example.

And also I just wonder whether we can regroup (higher level grouping) the groups we have deduces in above way?

解决方案

********** SOLUTION 1: (using groups) **********

Just define multiple Docket bean for each group, and u will get logical grouping as per your need.

@Bean
public Docket api1() {

return new Docket(DocumentationType.SWAGGER_2)
    .groupName("users")
    .select()
    .paths(PathSelectors.ant("/api/users/**"))
    .build();
}

@Bean
public Docket api2() {

return new Docket(DocumentationType.SWAGGER_2)
    .groupName("products")
    .select()
    .paths(PathSelectors.ant("/api/products/**"))
    .build();
}

Now you will get two groups in your swagger ui like below.

********** SOLUTION 2: (using tags) **********

You don't need to define multiple Docket bean just one is enough.

@Bean
public Docket api1() {

// here tags is optional, it just adds a description in the UI
// by default description is class name, so if you use same tag using 
// `@Api` on different classes it will pick one of the class name as 
// description, so better define your own description for them
return new Docket(DocumentationType.SWAGGER_2)
    .tags(new Tag("users", "users related"), 
          new Tag("products", "products related"))
    .select()
    .apis(RequestHandlerSelectors.basePackage("com.github"))
    .build();
}

After that you just need to annotate your api methods with @Api (at class level, default for all methods) or @ApiOperation (at method level, will override value at class level).

@RestController
@RequestMapping("/api/products")
@Api(tags = "products")
public class ProductController {

    @ApiOperation(value = "", tags = "products")
    @RequestMapping(method = RequestMethod.POST)
    @ResponseStatus(HttpStatus.CREATED)
    public Product createProduct(@RequestBody Product product) {

        return product;
    }
}

Tags in @ApiOperation (or in @Api) will work across controller as well, i.e. method in different controller classes (or controller itself) tagged with a given tag will be grouped together.

这篇关于端点按资源大笔标注进行分组?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！