menzilmekan-backend/plugins/ahmadfatoni/apigenerator
Ata 5b70d7c2a5 updated api 2024-07-18 03:57:09 +00:00
..
controllers updated api 2024-07-18 03:57:09 +00:00
helpers added plugins 2024-07-13 12:48:51 +00:00
lang/en added plugins 2024-07-13 12:48:51 +00:00
models added plugins 2024-07-13 12:48:51 +00:00
template added plugins 2024-07-13 12:48:51 +00:00
updates added plugins 2024-07-13 12:48:51 +00:00
Plugin.php added plugins 2024-07-13 12:48:51 +00:00
Readme.md added plugins 2024-07-13 12:48:51 +00:00
composer.json added plugins 2024-07-13 12:48:51 +00:00
plugin.yaml added plugins 2024-07-13 12:48:51 +00:00
routes.php updated controllers for api 2024-07-18 08:53:06 +05:00

Readme.md

API Generator

October CMS plugin to build RESTful APIs.

Features

  • Auto generate routes
  • Auto Generate Controller (CRUD)
  • Support relationship restful API

Install

composer require AhmadFatoni.ApiGenerator

Usage

Form

  • API Name : Name of your API module
  • Base Endpoint : Base endpoint of your API, ex : api/v1/modulename
  • Short Description : Describe your API
  • Model : select model that will be created API
  • Custom Condition : Build customer response using JSON modeling

Custom Condition Example

{
    'fillable': 'id,title,content',
    'relation': [{
        'name': 'user',
        'fillable': 'id,first_name'
    }, {
        'name': 'categories',
        'fillable': 'id,name
    }]
}
  • please replace single quote with quote

Contribute

Pull Requests accepted.

Contact

You can communicate with me using linkedin

License

The OctoberCMS platform is open-sourced software licensed under the MIT license.