有没有办法将测试文件导入到redoc x-codeSamples源字段中?

问题描述 投票:0回答:1

重做指南指定使用原始文本作为代码示例中的源: https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md#x-codeSamples 像这样:

lang: JavaScript
source: console.log('Hello World');

但是我想让我的 OpenApi3.0 YAML 成为一个动态文档,因此更愿意直接从测试文件导入代码,例如:

lang: JavaScript
source: #/tests/js_api_test.js

其中

js_api_test.js
的内容就是:

console.log('Hello World');

这样,只要测试通过,导入的代码就可以保证工作——保持文档的生命力。

鉴于我已经依赖于从 YAML 文件生成大量样板,因此保持文件的所有方面都保持活力似乎是理想的选择。

swagger documentation openapi redoc
1个回答
1
投票

找到答案:

                label: 'Python'
                source: {$ref: test.py}

将在那里导入相对路径文件test.py

© www.soinside.com 2019 - 2024. All rights reserved.