UNPKG

@coding-blocks/jsonapi-server

Version:

A config driven NodeJS framework implementing json:api

354 lines (353 loc) 11.2 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/swagger/index.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../../prettify.css" /> <link rel="stylesheet" href="../../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../../index.html">All files</a> / <a href="index.html">lib/swagger</a> index.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">33.33% </span> <span class="quiet">Statements</span> <span class='fraction'>7/21</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Branches</span> <span class='fraction'>0/18</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Functions</span> <span class='fraction'>0/2</span> </div> <div class='fl pad1y space-right2'> <span class="strong">33.33% </span> <span class="quiet">Lines</span> <span class='fraction'>7/21</span> </div> </div> </div> <div class='status-line low'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">'use strict' const swagger = module.exports = { } const jsonApi = require('../../') const url = require('url') const swaggerPaths = require('./paths.js') const swaggerResources = require('./resources.js') &nbsp; swagger.generateDocumentation = <span class="fstat-no" title="function not covered" >()</span> =&gt; { const swaggerDoc = <span class="cstat-no" title="statement not covered" >swagger._getSwaggerBase()</span> <span class="cstat-no" title="statement not covered" > swaggerDoc.paths = swaggerPaths.getPathDefinitions(jsonApi)</span> <span class="cstat-no" title="statement not covered" > swaggerDoc.definitions = swaggerResources.getResourceDefinitions(jsonApi)</span> <span class="cstat-no" title="statement not covered" > return swaggerDoc</span> } &nbsp; swagger._getSwaggerBase = <span class="fstat-no" title="function not covered" >()</span> =&gt; { const swaggerConfig = <span class="cstat-no" title="statement not covered" >jsonApi._apiConfig.swagger || { }</span> let basePath, host, protocol <span class="cstat-no" title="statement not covered" > if (jsonApi._apiConfig.urlPrefixAlias) {</span> const urlObj = <span class="cstat-no" title="statement not covered" >url.parse(jsonApi._apiConfig.urlPrefixAlias)</span> <span class="cstat-no" title="statement not covered" > basePath = urlObj.pathname.replace(/(?!^\/)\/$/, '')</span> <span class="cstat-no" title="statement not covered" > host = urlObj.host</span> <span class="cstat-no" title="statement not covered" > protocol = urlObj.protocol.replace(/:$/, '')</span> } else { <span class="cstat-no" title="statement not covered" > host = jsonApi._apiConfig.host</span> <span class="cstat-no" title="statement not covered" > basePath = jsonApi._apiConfig.base.substring(0, jsonApi._apiConfig.base.length - 1)</span> <span class="cstat-no" title="statement not covered" > protocol = jsonApi._apiConfig.protocol</span> } <span class="cstat-no" title="statement not covered" > return {</span> swagger: '2.0', info: { title: swaggerConfig.title, version: swaggerConfig.version, description: swaggerConfig.description, termsOfService: swaggerConfig.termsOfService, contact: { name: (swaggerConfig.contact || { }).name, email: (swaggerConfig.contact || { }).email, url: (swaggerConfig.contact || { }).url }, license: { name: (swaggerConfig.license || { }).name, url: (swaggerConfig.license || { }).url } }, host, basePath, schemes: [ protocol ], consumes: [ 'application/vnd.api+json' ], produces: [ 'application/vnd.api+json' ], parameters: { sort: { name: 'sort', in: 'query', description: 'Sort resources as per the JSON:API specification', required: false, type: 'string' }, include: { name: 'include', in: 'query', description: 'Fetch additional resources as per the JSON:API specification', required: false, type: 'string' }, filter: { name: 'filter', in: 'query', description: 'Filter resources as per the JSON:API specification', required: false, type: 'string' }, fields: { name: 'fields', in: 'query', description: 'Limit response payloads as per the JSON:API specification', required: false, type: 'string' }, page: { name: 'page', in: 'query', description: 'Pagination namespace', required: false, type: 'string' } }, paths: { }, definitions: { }, security: swaggerConfig.security || [ ], securityDefinitions: swaggerConfig.securityDefinitions || { } } } &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Sat Jan 27 2018 19:59:16 GMT+0530 (IST) </div> </div> <script src="../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../sorter.js"></script> </body> </html>