PHP code example of ovac / idoc

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

ovac / idoc example snippets

$app->bind('path.public', function ($app) { return $app->basePath('../your-public-path'); });
$app->register(\OVAC\IDoc\IDocLumenServiceProvider::class);

$app->configure('idoc');

 'path' => 'idoc',
 

'logo' => 'https://res.cloudinary.com/ovac/image/upload/h_300,w_380,c_fill,r_30,bo_20px_solid_white/aboust_ey5v1v.jpg',

'title' => 'iDoc API Reference',
 

'description' => 'iDoc Api secification and documentation.',
 

'contact' => [
        'name' => 'API Support',
        'email' => '[email protected]',
        'url' => 'http://www.ovac4u.com'
],
 

'license' => [
        'name' => 'MIT',
        'url' => 'https://github.com/ovac/idoc/blob/master/LICENSE.md'
],
 

'servers' => [
    [
        'url' => 'https://www.ovac4u.com',
        'description' => 'App live server.',
    ],
    [
        'url' => 'https://test.ovac4u.com',
        'description' => 'App test server.',
    ],
],
 

'external_description' => 'idoc.info', // Route name for external description, leave empty to use default description

'external_description' => 'idoc.info',

'resources/views/vendor/idoc/languages/LANGUAGE.blade.php',
 

 'security' => [
        'BearerAuth' => [
            'type' => 'http',
            'scheme' => 'bearer',
            'bearerFormat' => 'JWT',
        ],
    ],
 

return [
     //...,
  
     /*
     * The routes for which documentation should be generated.
     * Each group contains rules defining what routes should be termine what routes will be parsed in this group.
             * A route must fulfill ALL conditions to pass.
             */
            'match' => [

                /*
                 * Match only routes whose domains match this pattern (use * as a wildcard to match any characters).
                 */
                'domains' => [
                    '*',
                    // 'domain1.*',
                ],

                /*
                 * Match only routes whose paths match this pattern (use * as a wildcard to match any characters).
                 */
                'prefixes' => [
                    'api/*',
                ],

                /*
                 * Match only routes registered under this version. This option is ignored for Laravel router.
                 * Note that wildcards are not supported.
                 */
                'versions' => [
                    'v1',
                ],
            ],

            //...
        ],
    ],

return [
     //...,
  
     'routes' => [
          [
              'match' => [
                  'domains' => ['v1.*'],
                  'prefixes' => ['*'],
              ],
              '            ],
          ],
          [
              'match' => [
                  'domains' => ['v2.*'],
                  'prefixes' => ['*'],
              ],
              '

/**
 * @group User management
 *
 * APIs for managing users
 */
class UserController extends Controller
{

	/**
	 * Create a user
	 *
	 * [Insert optional longer description of the API endpoint here.]
	 *
	 */
	 public function createUser()
	 {

	 }
	 
	/**
	 * @group Account management
	 *
	 */
	 public function changePassword()
	 {

	 }
}

/**
 * @group Items
 */
class ItemController extends Controller
{

    /**
     * List items
     *
     * Get a list of items.
     *
     * @authenticated
     * @responseFile responses/items.index.json
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        //...
    }

    /**
     * Store item
     *
     * Add a new item to the items collection.
     *
     * @bodyParam name string ate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function store(Request $request)
    {
        //...
    }


    /**
     * Get item
     *
     * Get item by it's unique ID.
     *
     * @pathParam item integer 

    /**
     * @pathParam location_id he id of the user. Example: me
     * @queryParam page _id string The id of the room.
     * @bodyParam forever boolean Whether to ban the user forever. Example: false
     */

/**
 * @bodyParam title string ired The title of the post.
 * @bodyParam type string The type of post to create. Defaults to 'textophonious'.
 * @bodyParam author_id int the ID of the author
 * @bodyParam thumbnail image This is 

/**
 * @response {
 *  "id": 4,
 *  "name": "Jessica Jones",
 *  "roles": ["admin"]
 * }
 */
public function show($id)
{
    return User::find($id);
}

/**
 * @response {
 *  "id": 4,
 *  "name": "Jessica Jones",
 *  "roles": ["admin"]
 * }
 * @response 404 {
 *  "message": "No query results for model [\App\User]"
 * }
 */
public function show($id)
{
    return User::findOrFail($id);
}

/**
 * @transformercollection \App\Transformers\UserTransformer
 * @transformerModel \App\User
 */
public function listUsers()
{
    //...
}

/**
 * @transformer \App\Transformers\UserTransformer
 */
public function showUser(User $user)
{
    //...
}

/**
 * @transformer \App\Transformers\UserTransformer
 * @transformerModel \App\User
 */
public function showUser(int $id)
{
    // ...
}

/**
 * @responseFile responses/users.get.json
 */
public function getUser(int $id)
{
  // ...
}

/**
 * @responseFile responses/users.get.json
 * @responseFile 404 responses/model.not.found.json
 */
public function getUser(int $id)
{
  // ...
}

'url' => env('APP_URL', 'http://yourappdefault.app'),

/**
 * @responseResource App\Http\Resources\OrderResource
 */
public function show($id)
{
    return new OrderResource(Order::findOrFail($id));
}

/**
 * @responseResource 201 App\Http\Resources\OrderResource
 */
public function store(Request $request)
{
    $order = Order::create($request->all());
    return new OrderResource($order);
}

/**
 * @resourceName Order
 * @resourceDescription Represents an order in the system
 * @resourceStatus 200
 */
class OrderResource extends JsonResource
{
    public function toArray($request)
    {
        return [
            /**
             * @responseParam id integer      /**
             * @responseParam items array  * @responseParam name string 

   // config/idoc.ecommerce.php
   return [
       'title' => 'E-commerce API Documentation',
       'version' => '1.0.0',
       'description' => 'API documentation for e-commerce.',
       'terms_of_service' => 'https://example.com/terms',
       'contact' => [
           'name' => 'E-commerce API Support',
           'email' => '[email protected]',
           'url' => 'https://example.com',
       ],
       'license' => [
           'name' => 'MIT',
           'url' => 'https://opensource.org/licenses/MIT',
       ],
       'output' => '/docs/ecommerce', // Ensure this path is unique
       'hide_download_button' => false,
       'external_description' => route('ecommerce-doc-description'),
       'routes' => [
           [
               'match' => [
                   'domains' => ['*'],
                   'prefixes' => ['api/ecommerce/*'],
                   'versions' => ['v1'],
               ],
               '

// routes/web.php

// Documentation for the ecommerce routes
Route::group([], function () {
    // Set the idoc config to the ecommerce config
    config(['idoc' => config('idoc.ecommerce')]);

    // Define the route for the user documentation
    Route::view(config('idoc.path'), 'idoc::documentation');
});

bash
php artisan vendor:publish --tag=idoc-config

bash 
$ php artisan idoc:generate

sh
$ php artisan idoc:generate

sh
php artisan idoc:custom {config?}

   php artisan idoc:custom ecommerce
   

   php artisan idoc:custom ecommerce
   php artisan idoc:custom user