@egomobile/swagger-proxy

Extension for @egomobile/http-server, which connects to multiply Swagger / OpenAPI instances and merge their documents to one.

Install

Execute the following command from your project folder, where your package.json file is stored:

1npm install --save @egomobile/swagger-proxy

Usage

1import createServer from "@egomobile/http-server";
2import { setupSwaggerProxy } from "@egomobile/swagger-proxy";
3
4async function main() {
5  const app = createServer();
6
7  setupSwaggerProxy(app, {
8    baseDocument: {
9      info: {
10        title: "My merged API",
11        version: "1.0.0",
12      },
13    },
14
15    sources: [
16      {
17        url: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/link-example.json",
18      },
19      {
20        url: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/callback-example.yaml",
21      },
22      {
23        url: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.yaml",
24      },
25    ],
26  });
27
28  await app.listen(8080);
29
30  const baseURL = `http://localhost:${app.port}/swagger`;
31
32  console.log("You should now be able to access documentation at:");
33  console.log(`- ${baseURL}`);
34
35  console.log();
36
37  console.log("You can download documentation as files from:");
38  console.log(`- JSON: ${baseURL}/json`);
39  console.log(`- YAML: ${baseURL}/yaml`);
40}
41
42main().catch(console.error);

Documentation

The API documentation can be found here.