Laravel Spectrum Documentation

Welcome to the complete documentation for Laravel Spectrum. This directory contains detailed guides to help you make the most of Laravel Spectrum.

📚 Documentation Structure

🚀 Getting Started

• Installation and Configuration
  Learn how to install Laravel Spectrum and perform initial setup.

• Basic Usage
  Introduction to basic commands and common use cases.

• Quick Start
  A guide to get started with Laravel Spectrum in 5 minutes.

🎯 Feature Guides

• Features Overview
  Detailed explanation of all Laravel Spectrum features.

• Validation Detection
  About FormRequest and conditional validation detection.

• Response Analysis
  Support for API Resources, Fractal transformers, and pagination.

• Authentication Setup
  How to configure authentication methods like JWT, Sanctum, OAuth2.

• Mock Server
  How to automatically launch a mock API server from OpenAPI documentation.

⚡ Advanced Usage

• Performance Optimization
  Optimization techniques and parallel processing for large projects.

• Export Features
  How to export to Postman and Insomnia with configuration.

• Customization
  How to extend and customize Laravel Spectrum.

• CI/CD Integration
  How to integrate into continuous integration.

📖 Reference

• CLI Commands
  All available Artisan commands and options.

• Configuration Reference
  Detailed information about all settings in config/spectrum.php.

• API Reference
  Programmatic usage and hooks.

🔧 Troubleshooting

• Troubleshooting
  Common problems and their solutions.

• FAQ
  Frequently asked questions and answers.

• Known Issues
  Currently identified issues and workarounds.

📚 Others

• Comparison with Other Tools
  Feature comparison with Swagger-PHP, Scribe, L5-Swagger, etc.

• Migration Guide
  How to migrate from other documentation generation tools.

• Contributing Guide
  How to contribute to the project and guidelines.

🎯 Purpose-Based Guides

For New Projects

1. Installation and Configuration
2. Basic Usage
3. Features Overview

For Existing Projects

1. Installation and Configuration
2. Migration Guide
3. Troubleshooting

For Large Projects

1. Performance Optimization
2. CI/CD Integration
3. Customization

For API Testing Tool Integration

1. Export Features
2. Authentication Setup
3. CI/CD Integration

💡 Tips

• 🔍 If you're looking for a specific topic, check the table of contents in each document
• 📝 Actual code examples are abundantly included in each document
• 🚀 We recommend starting with the Quick Start and referring to detailed documentation as needed
• 💬 If you have questions or suggestions, please let us know via GitHub Issues

🔄 Updates

This documentation is regularly updated. Check the GitHub repository for the latest information.

---

Happy Documenting! 🎉