<% if( !$( "body" ).hasClass( "print" ) ){ %>
<% } %>
<% if( $( "body" ).hasClass( "print" ) ){ %>
API Service Overview:
<% } %>
<%= api.info.title %>
<% if( !_.isUndefined( api.info.version ) && api.info.version.length > 0 ) { %>
Version: <%= api.info.version %>
<% } %>
- Introduction:
- <%= api.info.description.replace(/(?:\r\n|\r|\n)/g, '
') %>
<% if( typeof( api.info.contact ) && !_.isEmpty( api.info.contact ) ){ %>
- Contact:
-
<% } %>
<% if( !_.isUndefined( api.info.license ) && !_.isUndefined( api.info.license.url ) ){ %>
- License:
<%= (
!_.isUndefined( api.info.license.name ) && api.info.license.name.length > 0
? api.info.license.name
: api.info.license.url
)
%>
<% } %>
<% if( !_.isUndefined( api.info.termsOfService ) && api.info.termsOfService.length > 0 ) { %>
<% if( api.info.termsOfService.indexOf( "http" ) === 0 ){ %>
-
Terms of Service: <%= api.info.termsOfService %>
<% } else { %>
- Terms of Service:
-
<%= api.info.termsOfService.replace(/(?:\r\n|\r|\n)/g, '
') %>
<% } %>
<% } %>
<% if( !_.isUndefined( api.externalDocs ) && !_.isUndefined( api.externalDocs.url ) ){ %>
- External Docs:
<%= (
!_.isUndefined( api.externalDocs.description ) && api.externalDocs.description.length > 0
? api.externalDocs.description
: api.externalDocs.url
)
%>
<% } %>
Service Entry Points
Service Available Paths
<% _.each( pathKeys, function( key){ %>
"><%= key %>
<% }); %>
MIME Types Consumed
<% _.each( api.consumes, function(type){ %>
<%= type %>
<% }); %>
MIME Types Returned
<% _.each( api.produces, function(type){ %>
<%= type %>
<% }); %>
<% if( !_.isUndefined( api[ "x-extensionDetection" ] ) ) { %>
Extension Detection: <%= api[ "x-extensionDetection"] %>
<% } %>
<% if( !_.isUndefined( api[ "x-throwOnInvalidExtension" ] ) ) { %>
Throws on Invalid Extension: <%= api[ "x-throwOnInvalidExtension"] %>
<% } %>
<% if( !_.isUndefined( api.securityDefinitions ) ) {
%>
Security Definitions
<%= securityDefinitionsTemplate( { "definitions":api.securityDefinitions } ) %>
<% } %>
<% if( !_.isUndefined( api.parameters ) ) { %>
Global Parameters
<%= paramTemplate( { "entity":api } ) %>
<% } %>
<%= renderXAttributes( api ) %>
<%= responseCodeTemplate() %>
<% if( $( "body" ).hasClass( "print" ) ){ %>
API Path Reference:
<% } %>
Available Paths: