Skip to content

A Polymer element that wraps the swagger-js library for generating dynamic swagger api clients for easy use in the browser.

Notifications You must be signed in to change notification settings

paulkoanui/swagger-api-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

swagger-api-client

A Polymer element that wraps the swagger-js library for generating dynamic swagger api clients for easy use in the browser.

Example:

<swagger-api-client
    spec="http://petstore.swagger.io/v2/swagger.json">
</swagger-api-client>

Install

Using Bower:

bower install swagger-api-client

Dependencies

Element dependencies are managed via Bower. You can install that via:

npm install -g bower

Then, go ahead and download the element's dependencies:

bower install

Playing With Your Element

If you wish to work on your element in isolation, we recommend that you use Polyserve to keep your element's bower dependencies in line. You can install it via:

npm install -g polyserve

And you can run it via:

polyserve

Once running, you can preview your element at http://localhost:8080/components/swagger-api-client/, where swagger-api-client is the name of the directory containing it.

Testing Your Element

Simply navigate to the /test directory of your element to run its tests. If you are using Polyserve: http://localhost:8080/components/swagger-api-client/test/

web-component-tester

The tests are compatible with web-component-tester. Install it via:

npm install -g web-component-tester

Then, you can run your tests on all of your local browsers via:

wct

WCT Tips

wct -l chrome will only run tests in chrome.

wct -p will keep the browsers alive after test runs (refresh to re-run).

wct test/some-file.html will test only the files you specify.

About

A Polymer element that wraps the swagger-js library for generating dynamic swagger api clients for easy use in the browser.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages