从另一个Swagger或OpenAPI文件

时间:2017-12-01 09:43:23

标签: python rest swagger api-design openapi

有一个大的Swagger / OpenAPI YAML规范,如何安全地提取某些API端点并为它们专门生成新的.yaml

从特定级别(如使用一个缩进或更多缩进定义)很容易识别API端点:

paths:
  /users:
    ...
      - $ref: '#/requests/getUser'
  /repos:
    ...
requests:
  getUser:
    ...

我只是将paths以外的所有部分复制到新的规范文件中。然后我会根据缩进复制某些paths小节,例如/users:。在Python中,使用正则表达式。

但这种直接方法对规格是否安全?

1 个答案:

答案 0 :(得分:0)

Swagger Inspector允许您进行API调用,然后从中创建定义文件(让您只选择您想要的一部分调用)。请参阅inspector.swagger.io - 它是基于UI的,但可能会为您节省一些时间。