BanchaDeveloperRemoteApi

Created: 2012-03-24 01:13
Updated: 2014-07-30 01:17
License: gpl-3.0
php

README.md

Bancha logo

API-Viewer for JS Developers

This Add-On for Bancha helps Developer-Teams in the process of creating Bancha Applications. JavaScript Frontend Developers no longer have to dig through any PHP code to find the available remote methods.

Instead they just open /developer-remote-api.html in debug mode in their browser and can view all remotely available CakePHP Controller methods.

Features

  • Dynamically reflects on CakePHP app
  • Displays searchable RemoteStubs
  • Uses both Reflection and PHPDoc comments
  • Supports code tags and MarkDown syntax

Bancha Developer Remote API Screenshot

How to setup the project

Asuming you already use Bancha 2.1.0+ on the site, just copy this plugin into Plugin/ or app/Plugin/ and add following line to your app/Config/bootstrap.php:

CakePlugin::load(array('BanchaDeveloperRemoteApi' => array('routes' => true))); 

More information about Bancha


This is a bancha-flavored light-weight build of Sencha JSDuck .

This project is distributed under the terms of the GNU General Public License version 3.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more