叠加层
叠加层
叠加层
叠加层允许您在不修改原始文件的情况下自定义 OpenAPI 规范。这在以下情况下很有用：
叠加层遵循 OpenAPI 叠加层规范 并在 OpenAPI 生态系统中可移植。
Fern 推荐对 OpenAPI 规范使用叠加层而非覆盖。
覆盖 也完全受支持。如果覆盖对您的团队有效，则无需切换。您也可以同时使用两者（先应用覆盖，再应用叠加层）。
要使用叠加层，请在规范文件所在的文件夹中创建 overlays 文件，并在 generators.yml 中引用它：
叠加层中的每个操作使用 JSONPath 定位元素，并应用 update 或 remove 操作：
Fern 要求在 JSONPath 过滤器表达式周围使用括号。使用 [?(@.name == 'plantId')] 而不是 [?@.name == 'plantId']。
使用 update 来更改标准 OpenAPI 属性，如描述、摘要或其他字段：
使用 update 添加 Fern 扩展：
使用 remove: true 从规范中删除元素：
generators.yml 中的每个规范接受一个叠加层文件。您可以在多个规范中引用同一个文件，或为不同的配置使用单独的文件。
当多个规范需要相同的自定义时，将它们指向同一个叠加层文件以避免重复：
如果每个规范需要独特的自定义，请为每个规范创建单独的叠加层文件：
通过创建各自包含 generators.yml 的单独文件夹，为 SDK 生成与文档使用不同的叠加层文件：
为生产环境与内部 API 配置不同的叠加层：