php-api-int

php-api-int is a Laravel library for dealing with api management.

Installation

Use the package manager composer to install php-api-int.

composer require walkerchiu/php-api-int

Usage

Package settings

# CLI

# Publish this package settings
php artisan vendor:publish

# Overwrite default settings
vi config/wk-api.php

# Overwrite translations
cd resources/lang/vendor/php-api
vi ...

# Overwrite views
cd resources/views/vendor/php-api
vi ...

# See migrations
cd database/migrations
cat ...

Core settings

# CLI

# Overwrite default settings
vi config/wk-core.php

# See class section
# See table section

Migrations

# CLI

# Generate a database migration
php artisan make:migration

# Run all of your outstanding migrations
php artisan migrate

# See which migrations have run thus far
php artisan migrate:status

How to use

Entity

In fact, this usage is not limited to Entity, and other usages such as Repository and Service are also similar.

You can view the source code to understand the methods provided by these classes.

# PHP

# Use directly
# You can find more settings in config/wk-core.php
use WalkerChiu\API\Models\Entities\Setting

Setting::all();

# PHP

# Use core setting
# You can find more settings in config/wk-core.php
use Illuminate\Support\Facades\App;

App::make(config('wk-core.class.api.setting'));

FormRequest

# PHP

# controller

# You can find more information in Models/Forms folder
use WalkerChiu\API\Models\Forms\SettingFormRequest

/**
 * Store a newly created resource in storage.
 *
 * @param  \WalkerChiu\API\Models\Forms\SettingFormRequest  $request
 * @return \Illuminate\Http\Response
 */
public function store(SettingFormRequest $request)
{
    # ...
}

Useful commands

# CLI

# Truncate all tables of this package
php artisan command:APICleaner

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License