QuickApi

REST-Like API Resource enabling Snippet-based API Endpoints

Creator: Jared Healy (jaredfhealy)

Need help installing this extra?

About QuickApi

Adds a light-weight REST-Like API methodology to your MODX instance.

  • Path format:
  • /[api path property]/[snake_case_method_name]?parameter=value1

  • Example URL with Default Path Property:
  • GET /api/hello_world?greeting=Yo, yo

  • Executed Snippet:
  • ApiHelloWorld

  • JSON Response
  • { "success": true, "message": "Yo, yo world!!" }

    Information

    Released
    November 26, 2020

    Supported Database
    MySQL

    License
    GPLv3

    Supported Versions
    2.7 - Current

    Downloads
    795

    Documentation
    QuickApi Documentation

    Instructions

    Install from the Extras Installer. See MODX Docs for details.

    New in 1.1.0-rc

    • Removed need to adjust Nginx or Apache rewrite rules
    • Added a plugin, QuickApiRoute, which handles the rewriting making setup quicker and easier
    • Added a system property to allow changing the API Path Root from "api/" to any value like "myapi/" or "api2/".

      Current releases

      1.1.0-rc
      View | Download
      November 26, 2020
      2.7 - Current

      1.0.0-beta2
      View | Download
      December 10, 2019
      2.7 - <2.7

      1.0.0-beta1
      View | Download
      December 5, 2019
      2.7 - <2.7