Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2.99 KB

README.md

File metadata and controls

73 lines (50 loc) · 2.99 KB
Raw

Swagger Connector

This is a Arrow connector to any Swagger defined API.

Installation

Just enter the following command in your arrow project root to install the Swagger connector.

appc install connector/appc.swagger

Usage

You will need to customize the configuration file generated for you to include at least a "swaggerDocs" key such as:

module.exports = {
  connectors: {
    'appc.swagger': {
      // The URL to the main api-docs for your Swagger API.
      swaggerDocs: 'http://petstore.swagger.io/v2/swagger.json',
      // ...
    }
  }
};

If the swagger definition is protected against unauthorized access with either http basic or api key authentication you can configure those under the login key.

Should your API itself require authentication, you can create a mapping of swagger security definitions to authentication providers under the authenticationProvider key. A mapping consists of the key for the swagger security definition and the config for the matching authentication provider. Supported authentication types include http basic, api key, cookie and Oauth2 (password and client credentials grant).

Please refer to the generated configuration file of this connector for usage examples for each mentioned authentication type above.

Development

This section is for individuals developing the Swagger Connector and not intended for end-users.

npm install
node app.js

Running Unit Tests

npm test

Contributing

This project is open source and licensed under the Apache Public License (version 2). Please consider forking this project to improve, enhance or fix issues. If you feel like the community will benefit from your fork, please open a pull request.

To protect the interests of the contributors, Appcelerator, customers and end users we require contributors to sign a Contributors License Agreement (CLA) before we pull the changes into the main repository. Our CLA is simple and straightforward - it requires that the contributions you make to any Appcelerator open source project are properly licensed and that you have the legal authority to make those changes. This helps us significantly reduce future legal risk for everyone involved. It is easy, helps everyone, takes only a few minutes, and only needs to be completed once.

You can digitally sign the CLA online. Please indicate your email address in your first pull request so that we can make sure that will locate your CLA. Once you've submitted it, you no longer need to send one for subsequent submissions.

Legal Stuff

Appcelerator is a registered trademark of Appcelerator, Inc. Arrow and associated marks are trademarks of Appcelerator. All other marks are intellectual property of their respective owners. Please see the LEGAL information about using our trademarks, privacy policy, terms of usage and other legal information at http://www.appcelerator.com/legal.