Strapi plugin logo for Custom-API-Builder

Custom-API-Builder

Visually design your custom API's (or custom reports / or custom views) directly from the Strapi CMS admin panel. Simply select the fields you need to show, enter a valid slug and let the plugin magically create the routes, controllers & services for you. Very easy to create & even easier to maintain.

thumbnail for Custom-API-Builder

Strapi Custom API Builder plugin

Design your custom API's (or custom reports / or custom views) directly from the Strapi CMS admin panel. Simply select the fields you need to show, enter a valid slug and let the plugin magically create the routes, controllers & services for you. Very easy to create & even easier to maintain.  

custom-api-builder-ss-3

 

⚙️ Versions

Strapi v4 - (current) - v1.x

 

Breaking changes in v1

  • Support for media & multiple media added
  • Support for multiple relationships at the same level added
  • The above features makes it incompatible with v0.x. The current version wont work with the custom API's created with v0.x.

🖐 Beta Release

We are still performing tests to make sure that the plugin is bug free. We will be adding several more features to the plugin in the recent future.

🚧 Roadmap

  • Build an API Visually from the Admin UI
  • Auto compose Routes, Controllers and Services
  • Complete UI tests
  • Use built in slug system to auto generate slugs and validate if they are unique
  • Add filtering capabilities
  • Add ordering/sorting capabilities
  • Add pagination capabilities
  • Robust way to handle both multi / single value
  • Manage multiple relations
  • Support Media & Multiple Media
  • Disable if no content types
  • Improve UI for scalability
  • When we have a field in the builder and its deleted from the content-type, handle it in a graceful way
  • When we have a new field, show it in the builder while editing
  • Provide a way to visualise the constructed query

⏳ Installation

Install Strapi with this Quickstart command to create a Strapi project instantly:

# with yarn
yarn create strapi-app my-project --quickstart

# with npm/npx
npx create-strapi-app my-project --quickstart

This command generates a brand new project with the default features (authentication, permissions, content management, content type builder & file upload). The Quickstart command installs Strapi using a SQLite database which is used for prototyping in development.

Add the strapi-designer plugin

yarn add strapi-plugin-custom-api@latest

# or

npm i -S strapi-plugin-custom-api@latest

Add the following config to /config/plugins.js file

1
2
3
4
5
module.exports = {
  "custom-api": {
    enabled: true,
  },
};

In case you don't have a plugins.js file, please create one.

After successful installation you've to build a fresh package that includes plugin UI. To archive that simply use:

yarn build && yarn develop

# or

npm run build && npm run develop

or just run Strapi in the development mode with --watch-admin option:

yarn develop --watch-admin

#or

npm run develop --watch-admin

Step by step installation of the plugin from scratch

https://www.loom.com/share/6ed4576bf2d645f5b7f45b7928c74def

The Custom API Builder plugin should appear in the Plugins section of Strapi sidebar after you run app again.

🚀 Usage

https://user-images.githubusercontent.com/34507994/172044022-7dce9138-d716-4806-a765-b446f24a94dd.mp4

As simple as that

🦸 Contributors

Install now

npm install strapi-plugin-custom-api

Last updated

22 days ago

Strapi Compatibility

>=4.0.0 <5.0.0-0

Author

github profile image for Vivek M. Agarwal
Vivek M. Agarwal

Useful links

Create your own plugin

Check out the available plugin resources that will help you to develop your plugin or provider and get it listed on the marketplace.