angular-swagger2-client v0.0.5
Angular OpenAPI/Swagger Client
A simple and powerful OpenAPI/Swagger Client for Angular, based on promises to connect with endpoint using OpenAPI/Swagger Specification 2.0.
Features
POST,PUT,GET,DELETE,PATCHandCONNECTrequest are supported.- Params in:
query,path,formDataandheaderare supported. SecuritySchemawithsecurityin API are supported(only typeapiKey).- By default,
PUTandPOSTrequest send withcontent-type: application/x-www-form-urlencoded. - Removes all parameters that have not been established in the API definition.
- Implements a Pre-Validator for params and supported
data types,formatandrequired. - Global static and dynamic default value based on LocalStorage.
- Support for uploading files using consume in the API definition and with at least one parameter in formData.
Getting Started
Install via NPM
npm install angular-swagger2-clientInstall via Bower
bower install angular-swagger2-client- Include the required libraries in your
index.html:
<html>
<head>
<title>My Angular Application</title>
<!-- Angular swagger Client -->
<script src="vendor/angular-swagger2-client/dist/angular-swagger2-client.js"></script>
</head>
<body>
...
</body>
</html>IMPORTANT: Where
vendoryou need replace for you downaload directory. If you ussingbowerreplace forbower_components, and if you usingnpmyou need replace fornode_modules
- Inject
angular-swagger2-clientmodule
angular.module('myApp', [
'angular-swagger2-client'
])- Prepare you swagger
angular.module('myApp', [
'angular-swagger2-client'
]).run(function($rootScope, AngularSwagger2Client) {
$rootScope.api = new AngularSwagger2Client(YouSwaggerJson);
})Requirements
- AngularJS 1.4+
API
object AngularSwagger2Client(Object jsonObject[, Object defaultStaticData[, Array defaultDynamicData]])Params
object jsonObject required
This param is required and expect a json object of swagger.
IMPORTANT: Only accepts the OpenAPI/Swagger Specification version 2.0.
object defaultStaticData optional
This parameter only accepts an object with keys and their respective values that will be used by default in all API's.
IMPORTANT: Parameters that have not been defined in the
parameterObjectorsecurityRequirementObjectwill not be used.
array defaultDynamicData optional
This parameter only accepts an array with the list of localStorage keys. These keys are processed at runtime to ensure current values are obtained.
IMPORTANT: Parameters that have not been defined in the
parameterObjectorsecurityRequirementObjectwill not be used.
Thanks:
This project is based on the angular-swaggerific repository.