将OpenAPI部署到本地主机

Question

我的组织有很多针对不同项目的API。我需要一个OpenAPI实现，它允许我为我们所有的产品创建一个包含所有这些API（更像是一个存储库）的独立门户。

有支持这一点的OpenAPI吗？

另一种选择是：能够将多个实例合并到单个OpenAPI实例。

Answer 1

为此，一个很好的解决方案是按照指示使用SwaggerHub。但是，这个工具对私有API不是免费的。我也有同样的需求，所以，为了帮助社区进行OpenAPI设计，我编写了一个名为“OpenAPI开发工具”的新工具（在github中）。

使用OpenAPI开发工具，我们可以为Swagger UI/Redoc部署多个文档（用于多个使用上下文），并具有热重新加载功能，例如SwaggerHub。

它真的很容易使用。

每个API都在配置文件中指示：

{
    "folder": "./specs",  // Root folder where the specifications are stored
    "specs": [            // Array of specifications (several specifications can be exposed)
        { // First specification file
            "file": "/petstore.yaml", // Relative path of the specification main file (from "folder" parameter). It has to be an OpenAPI file in YAML or JSON.
            "context": {    // Object used for template generation (see Template usage chapter below)
              ...
            }
        },
        { // Second specification file
        "file": "/petstore2.yaml"
            ...
        }
    ]
}

然后，只需点击npx openapi开发工具serve，就可以为整个API提供服务http://localhost:3000et voilá：）

Answer 2

有几种方法可以实现API目录。

Swagger UI 3.0.19可以使用url参数显示多个API定义。

// index.html

const ui = SwaggerUIBundle({
  dom_id: '#swagger-ui',
  urls: [
   {name: "petstore",  url: "http://petstore.swagger.io/v2/swagger.json"},
   {name: "instagram", url: "https://api.apis.guru/v2/specs/instagram.com/1.0.0/swagger.yaml"}
  ],
  "urls.primaryName": "petstore",  // default spec
  ...

结果：

由于Swagger UI是开源的，您可以自定义其布局和外观

SwaggerHub为团队提供API目录托管

披露：我在一家制造SwaggerHub的公司工作。