Microcks headers added (#33)

* A function is added that if there are examples, add them to the headers with the key X-Microcks-Response-Name key

---------

Co-authored-by: Dario Quinde <dario.quinde@cloudappi.net>
Co-authored-by: admin-cloudappi <admin@cloudappi.net>

Author: 3 people

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.1.0] - 2024-10-8
+
+## Added
+
+### Microcks headers added
+
+- Added 'microcks_headers' parameter in the environments config section to auto configure the Micrkocs headers.
+
+
+[2.1.0]: https://github.com/openapi2postman/releases/tag/2.1.0

example/o2p_config_file.json

@@ -31,7 +31,8 @@
             "target_folder": "pruebas",
             "has_scopes": false,
             "application_token": false,
-            "number_of_scopes": 0
+            "number_of_scopes": 0,
+            "microcks_headers": false
         },
         {
             "name" : "PROD",
@@ -44,7 +45,8 @@
             "custom_authorizations_file": "authorizations.postman_collection.json",
             "has_scopes": false,
             "application_token": true,
-            "number_of_scopes": 0
+            "number_of_scopes": 0,
+            "microcks_headers": false
         }
     ]
 }

index.js

@@ -3,6 +3,7 @@
 'use strict'
 const path = require('path');
 const _ = require('lodash');
+const examples = require('./src/generator/examples');
 const argv = require('yargs')(process.argv.slice(2))
     .option('c', {
         alias: 'configuration',
@@ -77,14 +78,18 @@ _.forEach(endpointsParsed, function (endpointParsed, i) {
 	endpointsParsed[i].authorization = require('./src/parser/authorization.js')(endpointParsed.verb, endpointParsed.path, authorizationTokens)
 	endpointsParsed[i].queryParams = require('./src/parser/'+version+'/queryParams.js')(endpointParsed.verb, endpointParsed.path)
 	endpointsParsed[i].summary = require('./src/parser/summary.js')(endpointParsed.verb, endpointParsed.path)
+	endpointsParsed[i].microcks = require('./src/parser/openapi3/microcks.js')(endpointParsed.verb, endpointParsed.path)
 });
+
 //GENERATOR-------------------------------- */
 let endpointsPostman = [];
 const endpoints = require('./src/generator/endpoints.js')(endpointsParsed);
+
 _.forEach(endpoints, function (endpoint, i) {
 	endpoint = require('./src/generator/testStatus.js')(endpoint);
 	endpoint = require('./src/generator/testBody.js')(endpoint, configurationFile);
 	endpoint = require('./src/generator/contentType.js')(endpoint);
+	endpoint = require("./src/generator/microcks.js")(endpoint);
 	endpoint = require('./src/generator/authorization.js')(endpoint, endpoint.aux.status)
 	global.currentId = endpoint.request.method + endpoint.request.url.path[0]
 	global.currentId = global.currentId.replace(/{{/g,'{').replace(/}}/g,'}').split('?')[0]
@@ -148,8 +153,36 @@ _.forEach(environments, function (element) {
 	if ( element.read_only ) {
 		exclude.write = true
 	}
-	// Se añaden casos de éxito por cada scope indicado en el fichero de configuración
-	// También se añaden los nuevos tokens como variables en la cabecera Authorization
+	if (element.microcks_headers) {
+		let actualLength = endpointsStage.length;
+		for (let i = 0; i < actualLength; i++) {
+		  const endpoint = endpointsStage[i];
+		  const responseNameHeader = endpoint.request.header.find(
+			(h) => h.key === 'X-Microcks-Response-Name'
+		  );
+	
+		  if (!responseNameHeader) {
+			if (!endpoint.request.header) {
+			  endpoint.request.header = [];
+			}
+				const pathArray = endpoint.request.url.path;
+			const path = '/' + pathArray.join('/');
+			const method = endpoint.request.method;
+			const status = endpoint.aux.status.toString();
+	
+			const exampleName = examples(path, method, status);
+	
+			const headerValue = exampleName || 'default';
+	
+			endpoint.request.header.push({
+			  key: 'X-Microcks-Response-Name',
+			  value: headerValue
+			});
+		  }
+		}
+	}
+	
+	  
 	if (element.has_scopes) {
 		let actualLength = endpointsStage.length;
 		for (let i = 0; i < actualLength; i++) {