Mocks server plugin allowing to create routes and collections from OpenApi definitions. 

Mocks server plugin allowing to create routes and collections from OpenApi definitions

javierbrea

@mocks-server/plugin-openapi

var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {

    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

    return new (P || (P = Promise))(function (resolve, reject) {

        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }

        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }

        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }

        step((generator = generator.apply(thisArg, _arguments || [])).next());

Object.defineProperty(exports, "__esModule", { value: true });

const openapi_types_1 = require("openapi-types");

const json_refs_1 = require("json-refs");

const constants_1 = require("./constants");

const methods = Object.values(openapi_types_1.OpenAPIV3.HttpMethods);

    return value !== null && value !== undefined;

    // /api/users/{userId} -> api/users/:userId

    return path.replace(/{(\S*?)}/gim, ":$1");

    // /api/users/{userId} -> api-users-userId

    return path.replace(/^\//gim, "").replace(/\//gim, "-").replace(/[{}]/gim, "");

        return avoidDoubleSlashes(`${basePath}/${replaceTemplateInPath(path)}`);

function routeId(path, method, mocksServerId) {

    return `${method}-${pathToId(path)}`;

    return mediaType.includes("application/json");

function openApiResponseBaseVariant(variantType, code, options) {

        id = options.exampleId ? `${code}-${variantType}-${options.exampleId}` : `${code}-${variantType}`;

        return code.startsWith("1") || code.startsWith("2") || code.startsWith("3");

    const statusCodes = codes.map(replaceCodeWildcards);

        return hasAnySuccessCode(statusCodes) ? 400 : 200;

    return Number(replaceCodeWildcards(code));

function openApiResponseExampleToVariant(exampleId, code, variantType, mediaType, openApiResponseExample, openApiResponseHeaders) {

    if (!notEmpty(openApiResponseExample) || !notEmpty(openApiResponseExample.value)) {

    const baseVariant = openApiResponseBaseVariant(variantType, code, { exampleId, customId: openApiResponseExample[constants_1.MOCKS_SERVER_VARIANT_ID] });

    return Object.assign(Object.assign({}, baseVariant), { options: {

            headers: Object.assign(Object.assign({}, openApiResponseHeaders), { [constants_1.CONTENT_TYPE_HEADER]: mediaType }),

            body: openApiResponseExample.value

function openApiResponseNoContentToVariant(code, openApiResponse) {

    const baseVariant = openApiResponseBaseVariant(constants_1.VariantTypes.STATUS, code, { customId: openApiResponse[constants_1.MOCKS_SERVER_VARIANT_ID] });

            headers: openApiResponse.headers,

function openApiResponseExamplesToVariants(code, variantType, mediaType, openApiResponseMediaType, openApiResponseHeaders) {

    const examples = openApiResponseMediaType.examples;

    const example = openApiResponseMediaType.example;

        return Object.keys(examples).map((exampleId) => {

            return openApiResponseExampleToVariant(exampleId, code, variantType, mediaType, examples[exampleId], openApiResponseHeaders);

    return Object.keys(examples).map((exampleId) => {

        return openApiResponseExampleToVariant(exampleId, code, variantType, mediaType, examples[exampleId], openApiResponseHeaders);

    const res = openApiResponseExampleToVariant("example", code, variantType, mediaType, { value: example }, openApiResponseHeaders);

function openApiResponseMediaToVariants(code, mediaType, openApiResponseMediaType, openApiResponseHeaders) {

    if (!notEmpty(openApiResponseMediaType)) {

        return openApiResponseExamplesToVariants(code, constants_1.VariantTypes.JSON, mediaType, openApiResponseMediaType, openApiResponseHeaders);

        return openApiResponseExamplesToVariants(code, constants_1.VariantTypes.TEXT, mediaType, openApiResponseMediaType, openApiResponseHeaders);

function openApiResponseCodeToVariants(code, openApiResponse) {

    const content = openApiResponse.content;

        return Object.keys(content).map((mediaType) => {

            return openApiResponseMediaToVariants(code, mediaType, content[mediaType], openApiResponse.headers);

    return [openApiResponseNoContentToVariant(code, openApiResponse)];

function routeVariants(openApiResponses) {

    const codes = Object.keys(openApiResponses);

        const response = openApiResponses[code];

        return openApiResponseCodeToVariants(getStatusCode(code, codes), response);

function getCustomRouteId(openApiOperation) {

    return openApiOperation[constants_1.MOCKS_SERVER_ROUTE_ID] || openApiOperation.operationId;

function openApiPathToRoutes(path, basePath = "", openApiPathObject) {

        if (notEmpty(openApiPathObject[method])) {

            const openApiOperation = openApiPathObject[method];

                id: routeId(path, method, getCustomRouteId(openApiOperation)),

                url: routeUrl(path, basePath),

                variants: routeVariants(openApiOperation.responses),

function openApiDefinitionToRoutes(openApiDefinition) {

    const openApiDocument = openApiDefinition.document;

    const basePath = openApiDefinition.basePath;

    const paths = openApiDocument.paths || {};

    return Object.keys(paths).map((path) => {

        return openApiPathToRoutes(path, basePath, paths[path]);

function documentRefsErrors(refsResults) {

    return Object.keys(refs).map((refKey) => {

        // @ts-expect-error expression of type 'string' can't be used to index type 'ResolvedRefDetails', but resolvedRefDetails.refs is in fact an object

function addOpenApiRefAlert(alerts, error) {

    alerts.set(String(alerts.flat.length), "Error resolving openapi $ref", error);

function resolveDocumentRefs(document, refsOptions, { alerts, logger }) {

    return (0, json_refs_1.resolveRefs)(document, refsOptions).then((res) => {

            logger.silly(`Document with resolved refs: '${JSON.stringify(res)}'`);

        const refsErrors = documentRefsErrors(res);

                refsErrors.forEach((error) => {

                    addOpenApiRefAlert(alerts, error);

                throw new Error(refsErrors.map((error) => error.message).join(". "));

            alerts.set(String(alerts.flat.length), "Error loading openapi definition", error);

  "name": "@mocks-server/plugin-openapi",

  "description": "Mocks server plugin allowing to create routes and collections from OpenApi definitions",

    "url": "https://github.com/mocks-server/main.git",

    "directory": "packages/plugin-openapi"

  "homepage": "https://www.mocks-server.org",

    "@mocks-server/nested-collections": "2.0.0"

  "readme": "<p align=\"center\"><a href=\"https://mocks-server.org\" target=\"_blank\" rel=\"noopener noreferrer\"><img width=\"120\" src=\"https://www.mocks-server.org/img/logo_120.png\" alt=\"Mocks Server logo\"></a></p>\n\n<p align=\"center\">\n  <a href=\"https://github.com/mocks-server/main/actions?query=workflow%3Abuild+branch%3Amaster\"><img src=\"https://github.com/mocks-server/main/workflows/build/badge.svg?branch=master\" alt=\"Build Status\"></a>\n  <a href=\"https://codecov.io/gh/mocks-server/main\"><img src=\"https://codecov.io/gh/mocks-server/main/branch/master/graph/badge.svg?token=2S8ZR55AJV\" alt=\"Coverage\"></a>\n  <a href=\"https://sonarcloud.io/project/overview?id=mocks-server_main_plugin-openapi\"><img src=\"https://sonarcloud.io/api/project_badges/measure?project=mocks-server_main_plugin-openapi&metric=alert_status\" alt=\"Quality Gate\"></a>\n  <a href=\"https://www.npmjs.com/package/@mocks-server/plugin-openapi\"><img src=\"https://img.shields.io/npm/dm/@mocks-server/plugin-openapi.svg\" alt=\"Downloads\"></a>\n  <a href=\"https://renovatebot.com\"><img src=\"https://img.shields.io/badge/renovate-enabled-brightgreen.svg\" alt=\"Renovate\"></a>\n  <a href=\"https://github.com/mocks-server/main/blob/master/packages/plugin-openapi/LICENSE\"><img src=\"https://img.shields.io/npm/l/@mocks-server/plugin-openapi.svg\" alt=\"License\"></a>\n</p>\n\n---\n\n# Mocks Server Plugin OpenApi\n\n[Mocks Server][website-url] plugin enabling to create routes and collections from OpenApi definitions.\n\n## Usage\n\nThis plugin is included in the main distribution of the Mocks Server project, so you can refer to the [official documentation website][website-url].\n\n## Options\n\n* __`plugins.openapi.collection.id`__ _(String | Null)_: Id for the collection to be created with __all routes from all OpenAPI documents__. Default is \"openapi\". When it is set to `null`, no collection will be created.\n* __`plugins.openapi.collection.from`__ _(String)_: When provided, the created collection will extend from this one.\n\nRead more about [how to set options in Mocks Server here](https://www.mocks-server.org/docs/configuration/how-to-change-settings).\n\n## Contributing\n\nContributors are welcome.\nPlease read the [contributing guidelines](../../.github/CONTRIBUTING.md) and [code of conduct](../../.github/CODE_OF_CONDUCT.md).\n\n[website-url]: https://www.mocks-server.org\n"

		@@ -98,8 +98,10 @@ "use strict";
		const examples = openApiResponseMediaType.examples;
		if (!notEmpty(examples)) {
		return null;
		const example = openApiResponseMediaType.example;
		if (notEmpty(examples)) {
		return Object.keys(examples).map((exampleId) => {
		return openApiResponseExampleToVariant(exampleId, code, variantType, mediaType, examples[exampleId], openApiResponseHeaders);
		}).filter(notEmpty);
		}
		return Object.keys(examples).map((exampleId) => {
		return openApiResponseExampleToVariant(exampleId, code, variantType, mediaType, examples[exampleId], openApiResponseHeaders);
		}).filter(notEmpty);
		const res = openApiResponseExampleToVariant("example", code, variantType, mediaType, { value: example }, openApiResponseHeaders);
		return res ? [res] : null;
		}
		@@ -106,0 +108,0 @@ function openApiResponseMediaToVariants(code, mediaType, openApiResponseMediaType, openApiResponseHeaders) {

		{
		"name": "@mocks-server/plugin-openapi",
		"version": "2.0.1",
		"version": "2.1.0",
		"description": "Mocks server plugin allowing to create routes and collections from OpenApi definitions",
		@@ -34,7 +34,7 @@ "keywords": [
		"dependencies": {
		"openapi-types": "12.0.2",
		"json-refs": "3.0.15"
		"json-refs": "3.0.15",
		"openapi-types": "12.1.3"
		},
		"devDependencies": {
		"@mocks-server/core": "4.0.1",
		"@mocks-server/core": "4.0.2",
		"@mocks-server/nested-collections": "2.0.0"
		@@ -41,0 +41,0 @@ },

Improved metrics

Dependency changes