angular-swagger-ui is an angularJS implementation of Swagger UI
Swagger helps you documenting your RESTful API.
Swagger UI helps developers discovering your RESTful API by providing an online documentation with an integrated API explorer.
By default, only JSON Swagger 2.0 is supported. To handle Swagger 1.2 please add module
swagger1-to-swagger2-convertersee Enable Swagger 1.2. To handle YAML please add moduleswagger-yaml-parsersee Enable YAML
By default, Authorization is not supported. To handle authorization (oauth2 is not implemented) please add module
swagger-authsee Enable authorization
A sample app using angular-swagger-ui is available here:
http://orange-opensource.github.io/angular-swagger-ui
bower install angular-swagger-ui --save
- angularJS
- bootstrap CSS
- angular-ui-bootstrap (required only if using Authorization)
All code in this repository is covered by the MIT license. See LICENSE file for copyright details.
Include angular-swagger-ui as a dependency into your application
As some properties of Swagger specifications can be formatted as HTML:
- You SHOULD include
ngSanitizeas a dependency into your application (avoids JS injection) if Swagger specifications are loaded from untrusted sources (seedist/index.htmlas an example) - You CAN add
trusted-sources="true"as directive parameter (avoids embeddingngSanitize) if Swagger specifications are loaded from trusted sources (seesrc/index.htmlas an example) - You MUST at least choose one of the two previous solutions
<script type="text/javascript">
// If directive has parameter trusted-sources="true"
angular.module('yourApp', ['swaggerUi']);
...
// OR if you choosed to use "ngSanitize"
angular.module('yourApp', ['ngSanitize', 'swaggerUi']);
...
</script>Create an HTML element in your angularJS application's template or in your HTML page
<div swagger-ui url="URLToYourSwaggerSpecification" api-explorer="true"></div>Add swagger-ui.min.js and angular.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<!-- if you choosed to use "ngSanitize" -->
<script src="yourPathToAngularSanitize/angular-sanitize.min.js"></script>
</body>Add swagger-ui.min.css and bootstrap.min.css to the head of the HTML page.
<body>
<head>
...
<link rel="stylesheet" href="yourPathToBootstrapCSS/bootstrap.min.css">
<link rel="stylesheet" href="yourPathToAngularSwaggerUI/dist/css/swagger-ui.min.css">
</head>
</body>Display or not API explorer, default is false
<div swagger-ui url="URLToYourSwaggerSpecification" api-explorer="true/false"></div>yourScopeVariable will be assigned to true or false depending on Swagger specification loading status
<div ng-show="yourScopeVariable">loading ...</div>
<div swagger-ui url="URLToYourSwaggerSpecification" loading="yourScopeVariable"></div>Define an error handler to catch errors, if none defined console.error is used
<div swagger-ui url="URLToYourSwaggerSpecification" error-handler="yourErrorHandler"></div>$scope.yourErrorHandler = function(/*String or Object*/ message, /*Integer*/ code){
}Allows having a URL direct access to a group of operations or to an operation and making it unfolded at startup
<div swagger-ui url="URLToYourSwaggerSpecification" permalinks="true/false"></div>Disable Swagger validator or define a custom Swagger validator. If parameter not defined, the validator will be 'http://online.swagger.io/validator'
<div swagger-ui url="URLToYourSwaggerSpecification" validator-url="false or URL"></div>Swagger specification parser is chosen depending on the Content-Type of the specification response. If host serving your Swagger specification does not send Content-Type: application/json then you can force the parser to JSON:
<div swagger-ui url="URLToYourSwaggerSpecification" parser="json"></div>Define a custom template to be used by SwaggerUI
<div swagger-ui url="URLToYourSwaggerSpecification" template-url="yourTemplatePath"></div><div swagger-ui input-type="json" input="yourJsonObject"></div>Make sure to use module swagger-yaml-parser, see Enable YAML
<div swagger-ui input-type="yaml" input="yourYamlString"></div><div swagger-ui input-type="url" input="yourURL"></div>angular-swagger-ui is available in english and french, english is used by default
To use french, add fr.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/i18/fr.min.js"></script>
</body>Set language to french at startup
<script type="text/javascript">
angular
.module('yourApp', ['swaggerUi'])
.config(function(swaggerTranslatorProvider) {
swaggerTranslatorProvider.setLanguage('fr');
});
...
</script>Set language to french at runtime
<script type="text/javascript">
angular
.module('yourApp', ['swaggerUi'])
.controller('yourController', function(swaggerTranslator) {
swaggerTranslator.useLanguage('fr');
});
...
</script>You can add your own languages, see src/scripts/i18n/en.js to find the keys you have to override
<script type="text/javascript">
angular
.module('yourApp', ['swaggerUi'])
.config(function(swaggerTranslatorProvider) {
swaggerTranslatorProvider.addTranslations('yourLangId', {
key: 'value'
...
});
swaggerTranslatorProvider.setLanguage('yourLangId');
});
...
</script>You can also use swaggerTranslator to internationalize your app by using a service, a directive or a filter
<body>
...
<div swagger-translate="yourKey" swagger-translate-value="yourParam"></div>
<div ng-bind="yourDynamicKey|swaggerTranslate:yourDynamicParam"></div>
...
<script type="text/javascript">
angular
.module('yourApp', ['swaggerUi'])
.config(function(swaggerTranslatorProvider) {
swaggerTranslatorProvider.addTranslations('en', {
yourKey: 'blablabla {{propertyNameOfYourParam}}'
...
});
})
.controller('yourController', function(swaggerTranslator) {
var localizedMessage = swaggerTranslator.translate('yourKey', yourParam);
});
...
</script>
</body>oauth is not implemented, only basic and API key authorizations are implemented.
Add swagger-auth.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/modules/swagger-auth.min.js"></script><!-- without angular-ui-bootstrap modal embedded -->
OR
<script src="yourPathToAngularSwaggerUI/dist/scripts/modules/swagger-auth-ui-boostrap-modal.min.js"></script><!-- angular-ui-bootstrap modal embedded -->
...
<script type="text/javascript">
angular
.module('yourApp', ['swaggerUi', 'swaggerUiAuthorization'])
...
</script>
</body>Add swagger1-to-swagger2-converter.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/modules/swagger1-to-swagger2-converter.min.js"></script>
</body>See Swagger 2.0 spec.
Add swagger-external-references.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/modules/swagger-external-references.min.js"></script>
</body>Add swagger-xml-formatter.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/modules/swagger-xml-formatter.min.js"></script>
</body>Add js-yaml library.
Add swagger-yaml-parser.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToJsYaml/js-yaml.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/modules/swagger-yaml-parser.min.js"></script>
</body>Add marked library.
Add swagger-markdown.min.js at the end of the body
<body>
...
<script src="yourPathToAngularJS/angular.min.js"></script>
<script src="yourPathToMarked/marked.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/swagger-ui.min.js"></script>
<script src="yourPathToAngularSwaggerUI/dist/scripts/modules/swagger-markdown.min.js"></script>
</body>Modifying angular-swagger-ui can be achieved by writing your own modules. As an example your can have a look at the ones in src/scripts/modules.
A module is an object (can be a service) having a function execute which must return a promise.
You can make your module modifying behaviours at different phases:
BEFORE_LOAD: allows modifying Swagger specification request before it is sentBEFORE_PARSE: allows modifying Swagger specification after it has been loadedPARSE: allows adding a Swagger parser for content types other than JSONBEFORE_DISPLAY: allows modifying internal parsed Swagger specification before it is displayedBEFORE_EXPLORER_LOAD: allows modifying API explorer request before it is sentAFTER_EXPLORER_LOAD: allows modifying API explorer response before it is displayed
angular
.module('myApp', ['swaggerUi'])
.service('myModule', function($q) {
this.execute = function() {
var deferred = $q.defer();
// if nothing done: call deferred.resolve(false);
// if success: call deferred.resolve(true);
// if error: call deferred.reject({message: 'error message', code: 'error_code'});
return deferred.promise;
}
})
.run(function(swaggerModules, myModule){
swaggerModules.add(swaggerModules.BEFORE_LOAD, myModule);
})
...
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent