在springdocs中，我可以基于操作上的标记定义多个OpenAPI定义吗

Question

我需要在一个应用程序中为同一个API使用springdocs定义两个不同的OpenApi定义：一个用于内部开发人员，一个用于外部开发人员。外部定义将包括内部定义中的一些操作，但不是所有操作。

我已经考虑过使用GroupedOpenApi创建这两个定义，但这需要我将应该从外部定义中排除的endpoint移动到单独的RestController中，并移动到排除的包中，该包不会包含在外部开发人员的定义中，但仍将包含在内部定义中。我更喜欢基于API定义而不是基于endpoint的安全访问来构造代码。

这似乎可以使用SecurityScheme或标记来定义在给定定义中包含哪些操作，例如使用GroupedOpenApi以及要包含的路径/包。因此，例如，我可以使用以下内容定义外部API的定义：

GroupedOpenApi.builder()
            .group("externalGroupName")
            .securitySchemesToInclude("externalSchemeName") // this doesn't currently exist
            .build();

然后，使用该SecurityScheme标记为SecurityRequest的任何操作都将添加到此外部定义中。例如，我可以在同一个RestController中定义以下两个endpoint：

将包括：

java prettyprint-override">    @SecurityRequirement(name = "externalSchemeName")
    @GET
    @Path("/pets")
    public Response getResponse(){
        return null;
    }
}

将不包括：

    @SecurityRequirement(name = "internalSchemeName")
    @GET
    @Path("/pets/internal")
    public Response getInternalResponse(){
        return null;
    }
}

使用这种方法，最好提供与路径/包包含/排除类似的包含/排除安全方案。

这似乎目前需要对springdocs做出贡献，除非我误解了如何创建多个定义的选项。有没有另一种方法可以实现从我定义的一个定义中排除一个操作，而不完全隐藏该操作，也不重组我的包？

请注意，如果可能的话，我也不愿意维护配置中应该从组中排除的所有路径的列表，因为这很容易出错，并且不允许跨多个服务提供共享配置。我更喜欢一个注释驱动的方法，类似于其他swagger定制的方式，这样我就定义了一次配置，然后根据注释更新每个资源，以驱动生成的swagger。

Answer 1

使用你的例子，你有其他过滤器（基于路径）的GroupeOpenApi，你没有使用：

    GroupedOpenApi.builder()
            .group("internalGroupName")
            .pathsToMatch("/pets/internal")
            .build();

    GroupedOpenApi.builder()
            .group("externalGroupName")
            .pathsToMatch("/pets")
            .packagesToExclude("/pets/internal")
            .build();