chame v0.8.0-dev

Meet 🍃 Chameleon — WIP

The next generation REST APIs Documentation, with simple configuration, cross language and framework. Just write one config and chameleon comments on your REST APIs project.

Single Command

Generate APIs documentation only using this command :

$ npx chame generate

Note : The command above, just for documentation. This project currently on development, so don't use it until release.

Preview v1.0

On development version Demo.

Usage

First of all, create chameleon.yml on your REST APIs project. With content like code below :

# chameleon.yml

name: Chameleon                   # Project Name
endpoint: https://somedomain.com  # Domain name / IP for API endpoint 
path: /api/v1                     # Route Group from APIs
source: src                       # Source directory to be generate by chameleon
destination: docs                 # Destination folder (default: docs)

You can use separate folder for destination, eg. public/docs

Next, create block comment on your documented method. Like example below :

<?php

namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UserController extends Controller
{
  /**
   * @chameleon
   * 
   * @name        : Show User
   * @description : Show the profile for the given user.
   * @route       : /user
   * @method      : GET
   * @parameter   : {
   *  id : Integer
   * }
   * @response    : {
   *  view     : HTML
   * }
   */
  public function show($id)
  {
      return view('user.profile', ['user' => User::findOrFail($id)]);
  }
}

Last, run this command on your root project :

$ npx chame generate

Note : This project under development, so don't use for production it after release. Except, you want to try this development version.

License

This project under MIT License