openapi / swagger 示例未显示

Question

我正在使用 spring-boot 3.2

这是我的依赖项： pom.xml

        <dependency>
            <groupId>org.springdoc</groupId>
            <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
            <version>2.5.0</version>
        </dependency>
        <plugin>
             <groupId>org.openapitools</groupId>
             <artifactId>openapi-generator-maven-plugin</artifactId>
             <version>7.6.0</version>
...

所以我想在一种模式下显示示例。这是我的测试端点：

openapi.yaml

paths:
  /tests:
    get:
      summary: 'test'
      description: 'test'
      operationId: getTestData
      responses:
        '200':
          description: 'test'
          content:
            application/json:
              schema:
                type: string
              examples:
                test-example:
                  value: 'test-data'

我大摇大摆地得到了： 用户界面图像 而且 v3/api-docs 也不包含示例 API 文档图像

生成的TestApi接口： TESTAPI 界面图

示例而不是示例也不起作用。参数和请求的示例也不起作用。 但模式级别的示例正在工作：

schemas:
    Email:
      type: string
      format: email
      description: 'User''s email'
      pattern: '^[A-Za-z0-9._-]+@[A-Za-z0-9.-]+\.[A-Za-z]{1,}$'
      example: '[email protected]'

Answer 1

导入 swagger 后，您应该对其进行配置。

这是一个基本示例：

@Configuration
public class SwaggerAPI {

  public OpenAPI customOpenAPI(@Value("${application.description}") String description) {
    return new OpenAPI().info(new Info()
        .title(description)
        .version("2.0")
        .termsOfService("http://swagger.io/terms")
        .license(new License().name("Apache 2.0").url("http://springdoc.org")));
  }

现在您可以在这里访问 swagger api 了：

http://localhost:{servicePort}/swagger-ui/index.html?继续