Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sudheesreedhara committed Aug 20, 2018
1 parent 9e6adcc commit 029f1c2
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,15 @@ openapi-apigee-node-utility
[![Build Status][travis-badge]][travis-url]
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

OpenAPI (formerly known as Swagger) to Apigee API Proxy Bundle using Node.js Utility
`openapi2apigee` module converts a standard Open API spec (previously known as Swagger) into an Apigee API Proxy bundle and deploys into an Apigee Edge Organization.

# Installation
# Pre-requisite
- node.js

You can install `openapi2apigee` either through npm or by cloning and linking the code from GitHub. This document covers the installation details for installing from npm.
# Installation
You can install `openapi2apigee` either through `npm` or by cloning the code from this GitHub repo. This README covers the installation steps with `npm`.

## Installation from npm

The `openapi2apigee` module (and its dependencies) is designed for Node.js and is available through npm using the following command:

### From a Terminal Window:
```bash
$ npm install -g openapi2apigee
Expand All @@ -26,12 +25,12 @@ $ npm install -g openapi2apigee

## <a name="generateapi"></a>generateApi

Generates Apigee API Bundles from OpenAPI files and help you deploy to Apigee Edge
Generates Apigee API Proxy bundle from OpenAPI specification file and deploys to Apigee Edge Organization.

#### Examples
#### Example

```bash
$ openapi2apigee generateApi petStore -s http://petstore.swagger.io/v2/swagger.json -D -d /Users/Anil/Desktop/
$ openapi2apigee generateApi petStore -s http://petstore.swagger.io/v2/swagger.json -D -d /Users/me/Desktop/
```

#### Articles
Expand Down

0 comments on commit 029f1c2

Please sign in to comment.