DEV Community: API Maker®

🚀 API Maker : Release Notes for v1.15.0

API Maker® — Tue, 22 Apr 2025 09:49:21 +0000

⭐ April 2025 ⭐

Changes

[IMPROVEMENT] : Default console logs limit set to 1_50_00_000 for each admin and developer user. Setting can be changed using redisInternal.maxCharsToStoreInConsoleLogs from environment variable or package.json or process variables.
[IMPROVEMENT] : When admin or developer users has “Process Initializers”, their sandbox will be automatically created for every process on every server. So it can execute some custom code without any action done by anyone.
[IMPROVEMENT] : Call external APIs will now support dot operator for array in setting values.

———— Virtual Field ————

[FEATURE] : Virtual field support added in schema. Deep populate is supported in virtual fields. Master save is also supported in virtual fields.
- Deep populate of virtual field will also work with save/update/delete APIs whenever we can see deep option.

👉 Virtual field video

———— Separate Sandbox ————

[FEATURE] : Automatic Sandbox Restart In Seconds settings support added in “Sandbox Settings” page.
[FEATURE] : We can create separate sandbox for custom APIs based on value of “separateSandboxSettings → enableSeparateSandboxForThis”
[FEATURE] : In separate sandbox of custom API, we can have default user packages from “Sandbox settings” by providing “separateSandboxSettings → packages → allowAllPackagesOfAdmin” setting to true.
[FEATURE] : In separate sandbox of custom API, we can have it’s own packages by providing “separateSandboxSettings → packages → sandboxPackages” with package name & version.
[FEATURE] : In separate sandbox of custom API, we can have separate dockerfile specific to that particular custom API with this setting "separateSandboxSettings → dockerFileOfSandbox”.

export interface ISeparateSandboxSettings {
    /**
     * ex: Sandbox_Group_1, system will create separate sandbox for this particular entity and "Automatic Sandbox Restart In Seconds" will have no effect on this sandbox.
     * All the packages of custom APIs having value "Sandbox_Group_1" will be available during execution.
     * */
    enableSeparateSandboxForThis?: string;

    /**
     * If any "separateSandboxSettings" has value in this, it will be used instead of "Sandbox Settings" DockerFile
     * */
    dockerFileOfSandbox?: string;

    /** It works when we have enableSeparateSandboxForThis as true. */
    packages?: {
        /** If true, this sandbox will have all the packages of admin. */
        allowAllPackagesOfAdmin?: boolean;

        /** If allowAllPackagesOfAdmin == false, then this settings will be applicable and these packages will be installed on this particular sandbox. */
        sandboxPackages?: {
            name: string;
            version: string;
        }[];
    }

    /** Sandbox will be restarted automatically based on these settings without failing any request. */
    autoRestart?: {
        /**
         * - It will work when enableSeparateSandboxForThis is true. <br/>
         * - Sandbox will be restarted after it passes these much of time, after its creation. */
        afterTheseMuchSeconds?: number;
    }
}

🚀 API Maker : Release Notes for v1.14.0

API Maker® — Thu, 03 Apr 2025 12:25:22 +0000

⭐ April 2025 ⭐

Changes

[IMPROVEMENT] : Prevent caching issue of UI after API Maker deployment.
[IMPROVEMENT] : Progressbar implemented in deployment screen.
[BUG] : $nin should not throw for null or empty string when userd with objectId field.
[BUG] : Getting error after saving data in sql server when uniqueidentifier is used as primary key.
[IMPROVEMENT] : Update & close button added in schema edit modal.
[IMPROVEMENT] : Error cleanup for SQL server driver related errors.
[BUG] : Date object in conversionFun is not working for SQL server save operation.
[IMPROVEMENT] : D2 diagram library installation related improvements.
[BUG] : When collection is not present and schema is present, it selects all items
[FEATURE] : Added support for isAutoGenerateByAM in schema as shown below.

import { ISchemaType, EType, ISchemaProperty, IPropertyValidation } from 'types';
import * as T from 'types';

let schema: ISchemaType = {
    _id: EType.objectId,
    name: EType.string,

    autoGenerateObjectId: {
        __type: EType.objectId,
        isAutoGenerateByAM: {
            valueGeneratorType: T.EValueGeneratorType.ObjectID,
        }
    },
    autoGenerate_GUID_UUID: {
        __type: EType.string,
        isAutoGenerateByAM: {
            valueGeneratorType: T.EValueGeneratorType.GUID_UUID,
        }
    },
    autoGenerate_ULID: {
        __type: EType.string,
        isAutoGenerateByAM: {
            valueGeneratorType: T.EValueGeneratorType.ULID,
        }
    },
    autoGenerate_ShortUUID: {
        __type: EType.string,
        isAutoGenerateByAM: {
            valueGeneratorType: T.EValueGeneratorType.ShortUUID,
        }
    }
};

module.exports = { schema };

UI Maker Extension

[IMPROVEMENT] : uim-grid-header class added for header.
[FEATURE] : editor control support added.
[FEATURE] : Required should support expression in UI Maker by providing requiredFun in validations.

[IMPROVEMENT] : Below two functions support added in utils object.

setDataInObject

setDataInArray

/** Useful to clear all properties of object and assign all properties of new object */
setDataInObject(oldObject: any, newObject: any): void;

/** Useful to clear all properties of object and assign all properties of new object */
setDataInArray(oldArray: any[], newArray: any[]): void;

[IMPROVEMENT] : DB Master page load performance improvements.
[IMPROVEMENT] : If we pass query parameter in iframe URL with name id and with value, UI Maker will open modal with that ID in edit mode by default. To open in view mode we can pass form-open-mode=view also.
[FEATURE] : UI Maker page can be used as only form also. Form can be used in add/edit/view modes.
[IMPROVEMENTS] : Add | Edit | Delete | View | Refresh Grid operations support added in user utils functions.
[IMPROVEMENT] : Added support for onceGridDataLoaded hook to process data once grid data loaded.
[FEATURE] : On click of button, generate sample working code of grid & form fields JSON and put it in editor. This button is available in top right corner of UI Maker page modal.
[FEATURE] : Add support for “uim” in schema, so we can generate code based on those settings also.

🚀 API Maker : Release Notes for v1.12.0

API Maker® — Thu, 20 Feb 2025 02:51:49 +0000

⭐ February 2025 ⭐

Changes

[BUG] : Getting circular dependency error in API call when same API is called from database pre hooks issue fixed. It should not call circular dependency as db hook has “skipHookRunning” by default true so it can not call itself.
[BUG] : Below type of query should work from get all schema API also

{ _id: { $eq: '5a66d40ff85cf20a385641f0' } }

[BUG] : objectId can be checked with empty string and boolean and it should not throw error for get all API in which data are getting passed as string
[FEATURE] : Develop screen which can deploy API Maker from NPM directly on all the servers of the environment.
[FEATURE] : Develop page which can take .tgz file and deploy on all the servers of the environment.

UI Maker Extension

[IMPROVEMENT] : Tooltip support added in all UI controls
[FEATURE] : Rating control support added and docs updated.
[FEATURE] : Knob control support added and docs updated.
[FEATURE] : Outline support added.
[IMPROVEMENT] : “cssClassDiv” property support added on column level, using that we can control grid system in which UI controls are being arranged.
- It will be applied to parent div which holds UI control in it.
[IMPROVEMENT] : “fields” property support added in column, so “fields” inside fields are now supported.
- Now we can easily created any type of complex grid structure, which was not possible earlier.

YouTube: https://www.youtube.com/@api_maker

Website: https://apimaker.dev/

Docs: https://docs.apimaker.dev/

🚀 API Maker : Release Notes for v1.11.0

API Maker® — Thu, 06 Feb 2025 13:45:09 +0000

⭐ February 2025 ⭐

Changes

[IMPROVEMENT] : passwordChangedAtColumn field support added in authorization. If we provide this column, it will avoid password field used in JWT. So if we open JWT we will not see encrypted password in JWT token.
[FEATURE] : Custom code write support added for web socket notification, so we can restrict users based on custom business logic.
[FEATURE] : Generate data will now ask for custom value to insert data.
[FEATURE] : Add support for defaults keyword in conversion.
[BUG] : conversionFun is not running when property is not present in payload issue fixed.
[FEATURE] : Add support for enum in validations.
[FEATURE] : Optimistic Concurrency Control [OCC] feature implemented. Need to add “isConcurrencyControlField” for that version field in schema.

— Update by ID, replace by ID, master save schema APIs will not allow update or replace without that version field and throw error if that version is mismatch with database value.

— API Maker will allow update & replace from custom code like custom APIs or events or schedulers etc. and will not have any effect in code. If you want concurrency control in custom code you can use “skipConcurrencyControl: false”.
[IMPROVEMENT] : Generate Data will take values from enum instead of random values. It will work in swagger docs and all the relevant APIs.
[BUG] : Generate APIs should automatically convert $regex value to JS RegExp object.
[BUG] : In find query, empty string condition in $and array property is not working issue fixed.

UI Maker Extension

[IMPROVEMENT] : Custom HTML support added for custom action button on grid & grid top level
[IMPROVEMENT] : Click event support added on grid custom button and top level grid custom button
[FEATURE] : Auto complete control support added.
[FEATURE] : Multi select control support added.

YouTube: https://www.youtube.com/@api_maker

Website: https://apimaker.dev/

Docs: https://docs.apimaker.dev/

🚀 API Maker : Release Notes for v1.9.0

API Maker® — Mon, 06 Jan 2025 14:01:37 +0000

⭐ January 2025 ⭐

Changes

[Feature] : Swagger Documentation support added.
[IMPROVEMENT] : Access visibility improvements in API Testing page.
[IMPROVEMENT] : Show radiation icon next to name for native APIs in warning colour.
[IMPROVEMENT] : Cloning support added for UI Maker Pages.
[IMPROVEMENT] : Some internal code improvements regarding host & port.
[IMPROVEMENT] : Show Notes about keys used in diagram in short form.
[BUG] : Custom APIs are not running in local when connected with mobile internet, happens in very rare scenario.
[BUG] : Generating diagram for across Database types issue fixed.

YouTube: https://youtu.be/lOXINOnyiDI?si=5bYiFxQCNfKz_FQf

Website: https://apimaker.dev/

Docs: https://docs.apimaker.dev/

🚀 API Maker : Release Notes for v1.8.3

API Maker® — Wed, 27 Nov 2024 05:51:43 +0000

⭐ November 2024 ⭐

Changes

[IMPROVEMENT] : Throw error when invalid value is provided when objectId expected based on schema.
[IMPROVEMENT] : groupNameMap will be present in object of g.req.auth.authAMUser
[IMPROVEMENT] : System should automatically save response of failed responses in logs.
[IMPROVEMENT] : Types improvements for g.req.params object in code.
[IMPROVEMENT] : reqInfo object is now available in g.req.reqInfo.
[BUG] : Modified request payload is not getting converted in query-stream POST API, issue fixed.
[BUG] : ER Diagram relations loading issue fixed for schemas where foreign key table, is provided in “table” field.

🚀 API Maker : Release Notes for v1.7.0

API Maker® — Wed, 21 Aug 2024 12:43:40 +0000

⭐ August 2024 ⭐

Changes

[BUG] : Update by id should throw error when it is not able to update DB data because of duplicate error or anything.
[BUG] : For WS connection not getting notification when objectid is used in criteria.
[IMPROVEMENT] : Show name of edit entity in modal header.
[IMPROVEMENT] : Custom APIs grid & tree both will display required authorization information in UI.
[IMPROVEMENT] : System APIs grid will show authorization information in UI.
[IMPROVEMENT] : API authorization information now visible for third party APIs tree.
[IMPROVEMENT] : No Access support added for APIs. It will be default access for system APIs.
[IMPROVEMENT] : Display auth information in API list for instance APIs.
[IMPROVEMENT] : Major performance improvement in types loading of code editor.
[IMPROVEMENT] : Add field and value support in duplicate error message, and it will also return field value.

🚀 API Maker : Release Notes for v1.6.0

API Maker® — Fri, 21 Jun 2024 10:46:23 +0000

⭐ June 2024 ⭐

Changes

[BUG] : Convert _id to valid Object id for executeQuery system API.
[BUG] : ISO dates should be automatically converted to valid date for generated APIs.
[Improvement] : Running commands for mongodb support added. We can create/delete index and lot more we can do using this feature.
[BUG] : $elemMatch = AM is not able to convert mongodb Id from string to ObjectId when used inside $elemMatch operator.

🚀 API Maker : Release Notes for v1.5.0

API Maker® — Thu, 04 Apr 2024 04:07:03 +0000

⭐ April 2024 ⭐

Changes

[Feature] : Vulnerability tracking feature added. It will give list of all vulnerabilities of API Maker itself and all the packages used in sandbox environment.
[Improvement] : getToken API generate data will have “u” and “p” fields.
[Improvement] : collection rename should also rename schema for mongodb.
[Improvement] : /token system api will also consider authorization. by default, it will be public as earlier but if settings are provided then they will be applied.
[Improvement] : Vulnerability related code improvements
[BUG] : Schema structure validation was not allowing to save string array when validation was present issue fixed.

🚀 API Maker : Release Notes for v1.4.0

API Maker® — Mon, 18 Mar 2024 06:09:17 +0000

⭐ March 2024 ⭐

Changes

[INSTALLATION] : Added support for adding secondary server in installation process.
- Validate Mongo connection string
- Validate Redis connection string
- Print steps how user can attach this secondary server to primary server.
[FEATURE] : Process Initializers feature added. They will immediately after sandbox created.
- Git integration support added for process initializers.
[FEATURE] : Restart all sandbox menu item added in user menu. They are useful to apply new changes of process initializers.

🚀 API Maker : Release Notes for v1.3.0

API Maker® — Thu, 15 Feb 2024 12:21:30 +0000

⭐ February 2024 ⭐

Changes

Automatic caching performance improvement for mongoDB.
[FEATURE] : TS generated interfaces feature added. New icon available in dashboard for that in utilities section. Very useful for frontend developers.
[FEATURE] : Git pull history feature added.
[FEATURE] : Docker image build history button added in sandbox settings
[IMPROVEMENT] : Generate class/model based on JSON feature.
- JSON is editable now.
- Valid json selection is not mandatory now. It will pick up sample JSON instead.
[FEATURE] : Multiple selection is now supported in git revert
[BUG] : WebSocket event revert issue fixed for custom APIs.
[IMPROVEMENT] : Packages upgraded and code improvements to address vulnerabilities.
[BUG] : DB user selection UI issue fixed in API testing.

🚀 API Maker : Release Notes for v1.2.0

API Maker® — Thu, 01 Feb 2024 11:45:14 +0000

⭐ February 2024 ⭐

Changes

[Feature] : “Restart process” menu item added in users menu which will restart all API Maker processes from all connected servers of that environment cluster
[Feature] : Multiple operators support added in find queries.
[Improvement] : UI improvements in code finder
UI Improvements.
[Improvement] : Set max memory usage for sandbox process and set default memory for Node.js process calculated based on system resources.
[Improvement] : Generate default values for generated APIs implemented
[Improvement] : Get All APIs will have default value 1000 in their query parameter
[Improvement] : UI improvement root user side.
[Improvement] : D2 library install operation will be done automatically on all linux servers
[Improvement] : Git related dependency packages upgraded.