Angular Swaggerific

A more "Angular" approach to interacting with your Swagger APIs.

Angular Swaggerific utilizes the promise-based $http API that is built into AngularJS. Your generated Swagger JSON file is used to create a `Swaggerific API`, which allows you to easily communicate with your Swagger defined endpoints.

{{appController.api}}

Get up and running in minutes.

Setting up Angular Swaggerific is super easy. Communicating with your endpoints using Angular Swaggerific is even easier.

1. Install Angular Swaggerific. Use Bower or download the source. It's up to you.
```
bower install angular-swaggerific
```

2. Include the required libraries.

<script src="bower_components/angular/angular.js"></script>
<script src="bower_components/angular-simple-sprite/angular-swaggerific.min.js"></script>

3. Inject the angular-swaggerific module into your app:
```
angular.module('myApp', ['angular-swaggerific']);
```

4. Implement the angular-swaggerific service:

angular
   .module('my-app', ['angular-swaggerific'])
   .run(function($log, $window, AngularSwaggerific){
	/**
	* Note that 'swaggerJson' refers to the generated JSON from your Swagger API. 
	* Visit editor.swagger.io to import your API and generate your JSON file.
	*/ 
	var mySwaggerAPI = new AngularSwaggerific($window.swaggerJson);

	MySwaggerAPI.{TAG}.{OPERATION_ID}({"id": 1})
	.then(function(data) { 
	    $log.log("Success! " + data);
	}, function(err) {
	    $log.log("Error! " + err);
	});
  });

Angular Swaggerific Documentation

Constructor

AngularSwaggerific(json)

Creates a new AngularSwaggerific object from a Swagger JSON object.

Arguments

json {Object} - The JSON generated by Swagger. This JSON can be generated using the Swagger Editor.

Returns

Swaggerific API {Object} - Returns an object representation of your provided Swagger API with all endpoints mapped to properties based on API tags, operationIds and methods. This object varies based on how your Swagger API is defined.

Gotchas

It is recommended that you provide a tag and operationId to all of the paths defined in your Swagger API. This way Angular Swaggerific can better construct your Swaggerific API object. If no tag is provided for a given path, then Angular Swaggerific will use the first variable in the path itself. If there are no path variables present, then Angular Swaggerific will default to using the base path. If there is no operationId present, then Angular Swaggerific will default to using the request method (get, post, put, delete, etc).

Tip: Use the API generator above to see exactly how your Swaggerific API is constructed.

Useage

// $window.json is defined elsewhere, and is the JSON generated by Swagger
var API = new AngularSwaggerific($window.json);

Communicating with your Swagger endpoints.

Communicating with your endpoints using the Swaggerific API is very easy. After you have created your API, each property (based on the tag and operationId of a path) triggers a request to its designated endpoint. Using the Swagger Simple PetStore API (as provided in the Swagger Editior) as an example:

// Initialize my Swaggerific API 
var myAPI = new AngularSwaggerific($window.SimplePetStore);

// Let's add a pet
myAPI.pets.addPet({"id": 1})
    .then(function(data) {
        $log.log("Success! " + data);
    }, function(err) {
        $log.log("Oops! Something went wrong! " + err);
    });

Angular Swaggerific is a promise-based service which allows you to easily interact with API endpoints created using Swagger.