Apigee Proxy to OpenAPI Web Tool

This tool allows you to upload an Apigee proxy bundle (.zip file) and generate an OpenAPI (Swagger) specification in YAML format. All processing is done client-side in your browser.

Installation

You can install this tool using npm. It's recommended to install it globally if you want to run it as a command, or locally if you want to integrate it into a project.

npm install -g apigee-to-openapi-webtool

(Replace apigee-to-openapi-webtool with the actual unique package name if it's different on npm).

If you install it locally:

npm install apigee-to-openapi-webtool

Usage

If installed globally:

After global installation, you might need to manually locate the package files if a direct command-line interface isn't the primary way it's set up (this package provides a web interface).

A simple way to run it is to use the npx command (for packages that offer a binary or a start script meant for serving):

npx apigee-to-openapi-webtool

This command will attempt to execute the start script defined in the package, which typically serves the index.html file on a local port (e.g., http://localhost:3000).

Alternatively, navigate to the global node_modules folder, find the package directory, and open index.html in your browser. The location of global node_modules can be found by npm root -g.

If installed locally:

1. Navigate to your project where you installed the package:

   cd your-project/node_modules/apigee-to-openapi-webtool

   (Adjust the path if your local node_modules structure is different or if it's a scoped package).
2. Serve the index.html file using a simple HTTP server. If you have serve installed (which is a dev dependency of this package), you can run:

   npx serve .

   This will serve the contents of the current directory.
3. Open your browser and go to the local URL provided by the server (usually http://localhost:3000 or similar).

You should now see the "Apigee Proxy to OpenAPI Generator" web page.

How it Works

1. Click the "Click to select a .zip file" area to choose your Apigee proxy bundle.
2. The selected file name will appear.
3. Click the "Generate OpenAPI Spec" button.
4. The tool will:
   • Check if an existing OpenAPI (.json or .yaml) specification is present in apiproxy/resources/oas/ within the bundle. If so, it uses that directly.
   • Otherwise, it parses the XML files in apiproxy/proxies/ to infer API paths, methods, and base paths.
5. The generated OpenAPI specification will be displayed in YAML format in the text area.
6. You can then "Copy YAML" to your clipboard or "Download YAML" as an openapi-spec.yaml file.

Features

• Client-side processing: No data is uploaded to any server.
• Supports .zip Apigee proxy bundles.
• Prioritizes existing OpenAPI specs within the bundle (apiproxy/resources/oas/).
• Generates a basic OpenAPI 3.0.0 spec from proxy endpoint definitions if no existing spec is found.
• Output in YAML format.

Contributing

If you'd like to contribute, please fork the repository and submit a pull request.

License

ISC