swagger-stats/examples/testapp/api.js

API Telemetry and APM. Trace API calls and Monitor API performance, health and usage statistics in Node.js Microservices, based on express routes and Swagger (Open API) specification

'use strict';

var express = require('express');
var apirouter = express.Router();
var debug = require('debug')('sws:testapp');


/**
 * @swagger
 * parameters:
 *  reusableparam:
 *    name: reusableparam
 *    in: query
 *    description: test reusable parameter
 *    required: true
 *    type: integer
 *    format: int64
 * definitions:
 *  pet:
 *    type: object
 *    required:
 *      - id
 *      - name
 *    properties:
 *      id:
 *        type: integer
 *        format: int64
 *      name:
 *        type: string
 *      tag:
 *        type: string
 *  newPet:
 *    type: object
 *    required:
 *      - name
 *    properties:
 *      id:
 *        type: integer
 *        format: int64
 *      name:
 *        type: string
 *      tag:
 *        type: string
 *  errorModel:
 *    type: object
 *    required:
 *      - code
 *      - message
 *    properties:
 *      code:
 *        type: integer
 *        format: int32
 *      message:
 *        type: string
 */


/**
 * @swagger
 *  /pets:
 *    get:
 *      description: Returns all pets from the system that the user has access to
 *      operationId: findPets
 *      produces:
 *        - application/json
 *        - application/xml
 *        - text/xml
 *        - text/html
 *      parameters:
 *        - name: tags
 *          in: query
 *          description: tags to filter by
 *          required: false
 *          type: array
 *          items:
 *            type: string
 *          collectionFormat: csv
 *        - name: limit
 *          in: query
 *          description: maximum number of results to return
 *          required: false
 *          type: integer
 *          format: int32
 *      responses:
 *        '200':
 *          description: pet response
 *          schema:
 *            type: array
 *            items:
 *              $ref: '#/definitions/pet'
 *        default:
 *          description: unexpected error
 *          schema:
 *            $ref: '#/definitions/errorModel'
 */
// NOT IMPLEMENTED


// API for tests ///////////////////////////////////////// //

/**
 * @swagger
 * /success:
 *   get:
 *     description: Test success response
 *     produces:
 *       - text/html; charset=utf-8
 *     responses:
 *       200:
 *         description: Success Response
 */
apirouter.get('/success', function (req, res) {
    res.status(200).send('OK');
});

/**
 * @swagger
 * /redirect:
 *   get:
 *     description: Test redirect response
 *     responses:
 *       302:
 *         description: Redirect Response
 */
apirouter.get('/redirect', function (req, res) {
    res.redirect('/v2/success');
});

/**
 * @swagger
 * /client_error:
 *   get:
 *     description: Test Client Error Response
 *     produces:
 *       - text/html; charset=utf-8
 *     responses:
 *       404:
 *         description: Not Found Response
 */
apirouter.get('/client_error', function (req, res) {
    res.status(404).send('Not found');
});

/**
 * @swagger
 * /server_error:
 *   get:
 *     description: Test Server Error Response
 *     produces:
 *       - text/html; charset=utf-8
 *     responses:
 *       500:
 *         description: Server Error Response
 */
apirouter.get('/server_error', function (req, res) {
    res.status(500).send('Server Error');
});


/**
 * @swagger
 * /tester/{code}:
 *   get:
 *     operationId: getTesterApi
 *     summary: Test API Get opeation
 *     description: Test Swagger API path with GET operation, producing response supplied in request parameter
 *     tags:
 *       - tester
 *       - GET
 *     produces:
 *       - application/json
 *     responses:
 *        default:
 *          description: Response Message
 *          schema:
 *            $ref: '#/definitions/errorModel'
 *   post:
 *     operationId: postTesterApi
 *     summary: Test API POST operation
 *     description: Test Swagger API path with POST operation, producing response supplied in request parameter
 *     tags:
 *       - tester
 *       - POST
 *     produces:
 *       - application/json
 *     responses:
 *        default:
 *          description: Response Message
 *          schema:
 *            $ref: '#/definitions/errorModel'
 *   put:
 *     description: Test PUT method and various responses
 *     produces:
 *       - application/json
 *     responses:
 *        default:
 *          description: Response Message
 *          schema:
 *            $ref: '#/definitions/errorModel'
 *   delete:
 *     description: Test DELETE method and various responses
 *     deprecated: true
 *     produces:
 *       - application/json
 *     responses:
 *        default:
 *          description: Response Message
 *          schema:
 *            $ref: '#/definitions/errorModel'
 *     parameters:
 *         - $ref: '#/parameters/reusableparam'
 *   parameters:
 *     - name: code
 *       in: path
 *       description: response code to return
 *       required: true
 *       type: integer
 *       format: int64
 *     - name: delay
 *       in: query
 *       description: delay to wait before responding
 *       required: false
 *       type: integer
 *       format: int64
 *     - name: message
 *       in: query
 *       description: message to return
 *       required: true
 *       type: string
 */
apirouter.get('/tester/:code', testerImpl );
apirouter.post('/tester/:code', testerImpl );
apirouter.put('/tester/:code', testerImpl );
apirouter.delete('/tester/:code', testerImpl );

// Test API that is not defined in swagger spec
apirouter.get('/noswagger/:code', testerImpl );
apirouter.post('/noswagger/:code', testerImpl );
apirouter.put('/noswagger/:code', testerImpl );
apirouter.delete('/noswagger/:code', testerImpl );

// Mock API request
// TODO Define in swagger spec
// TODO Describe parameter in header
apirouter.get('/mockapi', mockApiImpl );
apirouter.post('/mockapi', mockApiImpl );
apirouter.put('/mockapi', mockApiImpl);
apirouter.delete('/mockapi', mockApiImpl);
apirouter.head('/mockapi', mockApiImpl);
apirouter.options('/mockapi', mockApiImpl);
apirouter.connect('/mockapi', mockApiImpl);

/**
 * @swagger
 * /paramstest/{code}/and/{value}:
 *   get:
 *     operationId: getTestWithPathParams
 *     summary: Test API with path parameters
 *     produces:
 *       - application/json
 *     responses:
 *        default:
 *          description: Response Message
 *          schema:
 *            $ref: '#/definitions/errorModel'
 *     parameters:
 *       - name: code
 *         in: path
 *         description: first parameter
 *         required: true
 *         type: integer
 *         format: int64
 *       - name: value
 *         in: path
 *         description: second parameter
 *         required: true
 *         type: string
 *       - name: delay
 *         in: query
 *         description: second parameter
 *         required: false
 *         type: string
 */
apirouter.get('/paramstest/:code/and/:value', testerImpl );

function testerImpl(req, res) {
    var code = 500;
    var message = "ERROR: Wrong parameters";
    if(('params' in req) && 'code' in req.params ){
        code = parseInt(req.params.code);
        message = "Request Method:" + req.method +', params.code: ' + req.params.code;
    }

    if(('query' in req) && ('delay' in req.query)){
        var delay = parseInt(req.query.delay);
        setTimeout(function(){
            res.status(code).json({code: code, message: message});
        },delay);
    }else {
        res.status(code).json({code: code, message: message});
    }
}

function mockApiImpl(req,res){
    var code = 500;
    var message = "MOCK API RESPONSE";
    var delay = 0;
    var payloadsize = 0;

    // get header
    var hdrSwsRes = req.header('x-sws-res');

    if(typeof hdrSwsRes !== 'undefined'){
        var swsRes = JSON.parse(hdrSwsRes);
        if( 'code' in swsRes ) code = swsRes.code;
        if( 'message' in swsRes ) message = swsRes.message;
        if( 'delay' in swsRes ) delay = swsRes.delay;
        if( 'payloadsize' in swsRes ) payloadsize = swsRes.payloadsize;
    }

    if( delay > 0 ){
        setTimeout(function(){
            mockApiSendResponse(res,code,message,payloadsize);
        },delay);
    }else{
        mockApiSendResponse(res,code,message,payloadsize);
    }
}

function mockApiSendResponse(res,code,message,payloadsize){
    if(payloadsize<=0){
        res.status(code).send(message);
    }else{
        // generate dummy payload of approximate size
        var dummyPayload = [];
        var adjSize = payloadsize-4;
        if(adjSize<=0) adjSize = 1;
        var str = '';
        for(var i=0;i<adjSize;i++) str += 'a';
        dummyPayload.push(str);
        res.status(code).json(dummyPayload);
    }
}


module.exports = apirouter;