OpenAPI在嵌套类型中返回null

Question

我有由OpenAPI制作的带有Mybatis和Rest API的SpringBoot应用程序，这是我的swagger文件：

 /api/v1/getdata:
    get:
      summary: ttttttt
      tags:
        - "API"
      description: ttttttt
      operationId: getdata
      parameters:
        - name: sap
          in: header
          required: true
          description: ttttttt
          schema:
            type: string
        - name: created
          in: header
          required: true
          description: ttttttt
          schema:
            type: string
      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyResponse'
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyResponse'

components:
  schemas:    
    MyResponse:
        description: ttttttt
        type: object
        properties:
        code:
            description: ttttttt
            type: string
        body:
            $ref: '#/components/schemas/MyMetaData'
    
    MyMetaData:
      description: ttttttt
      type: object
      properties:
        id:
          description: id
          type: string
        somedata:
          description: ttttttt
          $ref: '#/components/schemas/MyData'
    
    MyData:
      description: ttttttt
      type: object
      properties:
        id:
          description: id
          type: string
        group:
          description: ttttttt
          type: string

这是我的控制器代码：

@Override
public ResponseEntity<MyResponse> getdata(String sap, String created) {
    MyResponse myResponse = new MyResponse();
    try {
        OffsetDateTime date = OffsetDateTime.parse(created, DateTimeFormatter.ISO_OFFSET_DATE_TIME);
        Optional<MyMetaData> optionalMetaData = Optional.ofNullable(this.MyMetaDataMapper.getdata(sap, date));
        if (optionalMetaData.isPresent()) {
            myResponse.setBody(optionalMetaData.get());
            myResponse.setCode("OK");
        }
        return ResponseEntity.status(HttpStatus.OK).body(myResponse);
    } catch (Exception e) {
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(myResponse);
    }
}

以下是生成的模型：

@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2022-03-01T12:24:46.999519+03:00")
public class MyMetaData   {
  @JsonProperty("id")
  private String id = null;

  @JsonProperty("somedata")
  private MyData somedata = null;

  public MyMetaData id(String id) {
    this.id = id;
    return this;
  }

当我像这样使用time-MyData时，结果得到null：

  somedata:
      description: ttttttt
      $ref: '#/components/schemas/MyData'

当一些数据是字符串类型时，我从数据库中获取一些正常数据。这里使用对象类型的正确方法是什么？

Answer 1

您共享的OpenAPI swagger文件有$ref：'#/组件/模式/MyData'，但组件和模式在MyData的路径中丢失。

按Open API留档应该是

components:
  schemas:
    User:    # Schema name
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1          # Property example
        name:
          type: string
          example: New order  # Property example

对于嵌套对象，已经有一个StackOverflow问题可能会有所帮助。Github问题。

你可以试试类似的

components:
  schemas:
    MyMetaData:
      type: object
      description: ttttttt
      properties:
        id:
          description: id
          type: string
        somedata:
          description: ttttttt
          $ref: '#/components/schemas/MyData'
    MyData:
      type: object
      description: ttttttt
      properties:
        id:
          description: id
          type: string  

如果您仍然面临OpenAPI swagger的问题，您可以尝试SpringDoc。它支持OpenAPI 3并轻松生成Swagger留档。您可以在网上找到很多示例。

示例：