Build APIs Faster
with Best Practices Built-in

composer require nomanur/api-starter-kit

php artisan api-starter-kit:install --sanctum --migrations

php artisan make:api-resource Post

php artisan make:api-resource Post \
    --model=Article \
    --controller=ArticlesController \
    --transformer=ArticleTransformer

php artisan make:api-resource Post --migration

namespace App\Http\Controllers\User;

use App\Http\Controllers\ApiController;
use App\Models\User;
use App\Transformers\UserTransformer;
use Illuminate\Http\Request;

class UserController extends ApiController
{
    public function __construct()
    {
        $this->middleware('transform.input:'.UserTransformer::class)->only(['store', 'update']);
    }

    public function index()
    {
        $users = User::all();
        return $this->showAll($users);
    }

    public function show(User $user)
    {
        return $this->showOne($user);
    }

    public function store(Request $request)
    {
        $rules = [
            'name' => 'required',
            'email' => 'required|email|unique:users',
            'password' => 'required|min:6|confirmed',
        ];

        $this->validate($request, $rules);

        $data = $request->except('password_confirmation');
        $data['password'] = bcrypt($request->password);
        
        $user = User::create($data);

        return $this->showOne($user, 201);
    }

    public function destroy(User $user)
    {
        $user->delete();
        return $this->showOne($user);
    }
}

namespace App\Transformers;

use App\Models\Post;
use LaravelApi\StarterKit\Transformers\BaseTransformer;

class PostTransformer extends BaseTransformer
{
    public function transform(Post $post): array
    {
        return [
            'id' => $post->id,
            'title' => $post->title,
            'content' => $post->content,
            'author' => $post->author?->name,
            'published' => $post->published_at?->toIso8601String(),
            'created_at' => $post->created_at->toIso8601String(),
            'updated_at' => $post->updated_at->toIso8601String(),
        ];
    }

    /**
     * Map transformed attributes to original attributes.
     */
    public static function originalAttribute(string $index): ?string
    {
        $attributes = [
            'id' => 'id',
            'title' => 'title',
            'content' => 'content',
            'author' => 'author',
            'published' => 'published_at',
            'created_at' => 'created_at',
            'updated_at' => 'updated_at',
        ];

        return $attributes[$index] ?? null;
    }

    /**
     * Map original attributes to transformed attributes.
     */
    public static function transformedAttribute(string $index): ?string
    {
        $attributes = [
            'id' => 'id',
            'title' => 'title',
            'content' => 'content',
            'author' => 'author',
            'published_at' => 'published',
            'created_at' => 'created_at',
            'updated_at' => 'updated_at',
        ];

        return $attributes[$index] ?? null;
    }
}

namespace App\Models;

use LaravelApi\StarterKit\Models\ApiModel;
use Illuminate\Database\Eloquent\Factories\HasFactory;

class Post extends ApiModel
{
    use HasFactory;

    public static $transformer = \App\Transformers\PostTransformer::class;

    protected $fillable = ['title', 'content', 'published_at'];

    protected $casts = [
        'published_at' => 'datetime',
    ];
}

use Illuminate\Support\Facades\Route;
use App\Http\Controllers\Api\PostsController;

// Public routes
Route::get('/posts', [PostsController::class, 'index']);
Route::get('/posts/{post}', [PostsController::class, 'show']);

// Protected routes
Route::middleware('api.auth')->group(function () {
    Route::post('/posts', [PostsController::class, 'store']);
    Route::put('/posts/{post}', [PostsController::class, 'update']);
    Route::delete('/posts/{post}', [PostsController::class, 'destroy']);
});

php artisan api-starter-kit:install --sanctum

Route::middleware('api.auth')->group(function () {
    Route::get('/user', function (Request $request) {
        return $request->user();
    });
});

curl -H "Authorization: Bearer YOUR_TOKEN" \
    http://example.com/api/v1/user

use LaravelApi\StarterKit\Http\Middleware\ApiAuthenticate;
use LaravelApi\StarterKit\Http\Middleware\ApiCors;
use LaravelApi\StarterKit\Http\Middleware\ApiRateLimit;

// Inside the configure block:
$middleware->alias([
    'api.auth' => ApiAuthenticate::class,
    'api.rate_limit' => ApiRateLimit::class,
    'api.cors' => ApiCors::class,
]);

Route::middleware(['api.auth', 'api.rate_limit'])->group(function () {
    // Protected and rate-limited routes
});

GET /api/v1/posts?per_page=10&page=2&sort_by=created_at&desc=true

// Success response
api_response($data, 'Success message', 200);

// Error response
api_error('Error message', 400, $errors);

// Paginated response
api_paginated($paginator, 'Success message', 200);

php artisan api:export

php artisan api:export --name="My API v2" --output=docs/api.json

php artisan api:export --bearer="your-token-here"

php artisan api:export --group-by=middleware

# Only export user and post routes
php artisan api:export --include="users|posts"

# Exclude health check and debug routes
php artisan api:export --exclude="health|debug"

# Combine both
php artisan api:export --include="api/v1" --exclude="health"

'postman' => [
    'collection_name' => env('API_POSTMAN_COLLECTION_NAME', null),
    'base_url' => env('API_POSTMAN_BASE_URL', '{{base_url}}'),
    'auth_middleware' => ['auth:sanctum', 'auth:api', 'auth', 'api.auth'],
    'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'structured' => true,
    'output_path' => 'postman_collection.json',
],

📦 Exporting Postman Collection...

✅ Postman Collection exported successfully!

+--------+---------------------+------------------+-------------------+
| Method | URI                 | Name             | Middleware        |
+--------+---------------------+------------------+-------------------+
| GET    | api/health          | —                | —                 |
| GET    | api/users           | users.index      | auth:sanctum      |
| POST   | api/users           | users.store      | auth:sanctum      |
| GET    | api/users/{user}    | users.show       | auth:sanctum      |
| PUT    | api/users/{user}    | users.update     | auth:sanctum      |
| DELETE | api/users/{user}    | users.destroy    | auth:sanctum      |
+--------+---------------------+------------------+-------------------+

📄 Collection: My API Collection
📁 File: /path/to/storage/app/postman_collection.json
🔢 Routes exported: 6
📦 File size: 4.52 KB

php artisan vendor:publish --tag=api-starter-kit-config

'response' => [
    'success_key' => 'data',
    'message_key' => 'message',
    'error_key' => 'error',
    'meta_key' => 'meta',
    'links_key' => 'links',
],

'cache' => [
    'enabled' => true,
    'ttl' => 60, // minutes
],

'rate_limit' => [
    'enabled' => true,
    'max_attempts' => 60,
    'decay_minutes' => 1,
],

GET /health

composer test