strapi-plugin-custom-api

Create custom API's from within the Admin dashboard of Strapi.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
strapi-plugin-custom-api
1081.0.34 months ago4 months agoMinified + gzip package size for strapi-plugin-custom-api in KB

Readme

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
 

🖐 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

  • x Build an API Visually from the Admin UI
  • x 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
  • 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
  • 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
module.exports = {
  "custom-api": {
    enabled: true,
    resolve: "./src/plugins/custom-api",
  },
};
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

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
StrapiPluginWeek