openapi - Redocly x-codeSamples 引用文件？

Question

在 Redocly 中，如何在 x-codeSamples 标记中引用外部文件？Redocly 参考指南：https ://redoc.ly/docs/api-reference-docs/vendor-extensions/redoc-supported-extensions/#x-codesamples

在以下示例中，第一种情况（“示例请求”）正确呈现。第二种情况（'Schema'），仅呈现为“[object object]”。这个标签是否支持 $ref 语句？

x-codeSamples:
    - lang: 'Example request'
      source: |
        PetStore.v1.Pet pet = new PetStore.v1.Pet();
        pet.setApiKey("your api key");
    - lang: 'Schema'
      source:
        $ref: ../components/schemas/Test_schema.yaml

Answer 1

不确定您是否仍然需要它，但您可以尝试使用方案定义标签，执行以下操作：

x-codeSamples:
    - lang: 'Example request'
      source: |
        PetStore.v1.Pet pet = new PetStore.v1.Pet();
        pet.setApiKey("your api key");
    - lang: 'Schema'
      source: |
        <SchemaDefinition schemaRef="../components/schemas/Test_schema.yaml" />

基于在https://github.com/Redocly/redoc/blob/master/demo/openapi.yaml的 Petstore 示例中如何使用 SchemaDefinition