包简介

API starter kit for the Laravel framework

README 文档

README

Minimal Laravel starter kit aimed at accelerating API development with authentication, and comprehensive documentation tooling built in.

Whats Inside?

✨ Authentication Ready

Laravel Fortify as the backend for user management
- Create access token
- Refresh access token
- Revoke access token
Laravel Sanctum integration for API token management with refresh token support
Token-based authentication with configurable abilities and access levels

📚 Auto-Generated Documentation

Scribe integration with custom extensions for enhanced API docs
- Improved Postman collection generation with pre-request script for automatic token generation for all endpoints
- Supports environment variables in API Documentation
Structured response documentation with reusable classes (using Attributes)
Structured API Documentation with groups & subgroups (using Attributes)

🏗️ Optional Action-based Architecture

Action-based architecture for business logic
DTOs for type-safe data transfer

🧪 Testing Foundation

Pre-configured Pest testing setup, with existing tests for authentication
PHPStan for static analysis
PHP CS Fixer for code style

Quick Start

Install using Laravel new command: See https://laravel.com/docs/12.x/starter-kits#community-maintained-starter-kits
```
laravel new example-api --using=creativitykills/api-starter-kit
```

Using Composer

composer create-project creativitykills/api-starter-kit

Your API documentation will be available at /docs and your API endpoints will be ready for authentication and token management.

Default API Endpoints

POST /v1/auth/token/create - User authentication and token issuance
POST /v1/auth/token/refresh - Refresh access tokens
POST /v1/auth/token/revoke - Revoke access tokens

Project Structure

The starter kit remains largely unchanged from the original Laravel application. However, here are some of the notable changes that have been made to the project.

Click to expand project structure

api-starter-kit/
├── app/
│   ├── Actions/
│   │   ├── Fortify/                         # User management actions (Laravel Fortify)
│   │   └── Sanctum/                         # API token management actions (Laravel Sanctum)
│   │       └── IssueAccessToken.php         # This action can be used to issue API tokens 
│   ├── Contracts/                           # Interface definitions
│   │   └── SupportsDocumentation.php        # This interface is used to document API endpoints, usable in Requests & Actions
│   ├── Data/
│   │   ├── Enums/                           
│   │   │   ├── Abilities.php                # This enum is used to define the abilities of a user token
│   │   │   └── AccessLevel.php              # This enum is used to define groups of abilities as access levels
│   │   ├── IssueAccessTokenDto.php          # This class is a simple DTO for holding the data needed to issue a new access token
│   │   └── IssuedAccessTokenDto.php         # This class is a simple DTO for holding the data of an issued access token
│   ├── Extensions/
│   │   └── Scribe/                          # Here extend some parts of the Scribe package to allow for even better documentation
│   │       ├── Concerns/
│   │       │   └── ExtendableAttributeNames.php
│   │       ├── Config/
│   │       │   └── Defaults.php
│   │       ├── Extracting/
│   │       │   └── Strategies/               # Extend the strategies to allow for custom responses and documentation groups
│   │       │       ├── Metadata/
│   │       │       │   ├── GetFromDocBlocks.php
│   │       │       │   ├── GetFromMetadataAttributes.php
│   │       │       │   └── GetValidationRulesFromAction.php
│   │       │       └── Response/
│   │       │           └── UseResponseAttributes.php
│   │       └── Writing/                      # Added support for generating even better Postman collections with pre-request scripts
│   │           ├── Postman/
│   │           │   ├── PostmanCollectionWriter.php
│   │           │   ├── PostmanEndpointProcessor.php
│   │           │   └── Processors/           # Processors allow you even greater control over the Postman collection
│   │           │       ├── CreateTokenEndpointProcessor.php
│   │           │       ├── EndpointProcessor.php
│   │           │       └── RefreshTokenEndpointProcessor.php
│   │           └── Writer.php
│   ├── Http/
│   │   ├── [...]
│   │   ├── Documentation/                     # API documentation structure classes
│   │   │   ├── Groups/                        # API Documentation groups
│   │   │   │   ├── AuthenticationGroup.php    
│   │   │   │   ├── GenericGroup.php           
│   │   │   │   └── GenericSubgroup.php        
│   │   │   └── Responses/                     # API Response documentation classes
│   │   │       ├── Authentication/
│   │   │       │   └── AccessTokenResponse.php # Response documentation for access tokens
│   │   │       ├── BadRequestResponse.php
│   │   │       ├── CreatedResponse.php
│   │   │       ├── [...]
│   │   │       ├── UnauthorizedResponse.php
│   │   │       └── UnprocessableEntityResponse.php
│   │   └── [...]         
│   └── [...]           
└── [...]

creativitykills/api-starter-kit 适用场景与选型建议

creativitykills/api-starter-kit 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 4 次下载、GitHub Stars 达 1，最近一次更新时间为 2025 年 08 月 30 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「api」「laravel」「kit」「starter」「starter-kit」「api-starter-kit」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 creativitykills/api-starter-kit 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 creativitykills/api-starter-kit 我们能提供哪些服务？

定制开发 / 二次开发

基于 creativitykills/api-starter-kit 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发