1. Intro & Setup
Welcome to the Laravel API course! Get ready to dive into the exciting world of building APIs with Laravel, the powerful and flexible PHP framework.
15:57
2. Cleaning up Laravel
Ready to supercharge your Laravel project for an API-first approach? Let’s dive into optimizing and cleaning it up to make it lightning-fast and ultra-efficient!
16:19
3. Data Modeling
When building an API, mastering the art of structuring your data and defining dynamic relationships between various entities is absolutely essential in Laravel 11.
24:27
4. API Design
When you design an API, it’s absolutely crucial to understand that every API should have a meaningful purpose!
33:09
5. Authentication & Authorization
Say goodbye to the hassle of manually crafting every single detail, and say hello to a streamlined, efficient process that keeps your endpoints vividly documented and ready to go!
14:15
6. Rate Limiting
When it comes to managing API requests, rate limiting is a key player. You don’t want to open the floodgates and let users bombard your API with endless requests.
8:24
7. API Versioning
API versioning might sound like a minor detail at first, but trust me, it's one of those decisions that can make or break the future usability of your API.
22:22
8. Pagination
When you're handling requests that could return extensive lists of resources, it's essential to implement pagination to ensure your responses are manageable and user-friendly.
11:43
9. API Standards
API standards, while useful, aren’t the be-all and end-all. What often takes precedence is discoverability and consistency in your API design.
26:17
10. Handling Errors
Today, we'll explore how to leverage Laravel 11’s error handling system by implementing the API Problem Specification and enhancing it with custom packages to provide consistent, informative error responses.
26:49
11. Write Operations
Let’s explore the steps to manage resources in a Laravel 11 API, focusing on creating, validating, updating, and deleting resources. We’ll use a real-world approach to ensure clarity and usability.
29:30
12. Internationalization
In our previous video, we dove deep into handling write operations—everything from data validation and authorization to deciding between synchronous and asynchronous processing.
11:44
13. Caching Data
In our previous video, we dove deep into handling write operations—everything from data validation and authorization to deciding between synchronous and asynchronous processing.
18:08
14. Basic Security
When it comes to API security, think of it not as a threat but as an opportunity—a chance to build robust, multilayered defenses around your API.
9:53
15. Cache Requests
In Laravel 11, we can take advantage of built-in HTTP features to manage our cache more effectively, streamlining both the response time and the overall user experience.
8:40
16. Scheduling tasks & Sending requests
When working on a Laravel API, the task scheduling system plays a significant role in automating background jobs.
40:33
17. Notifications
Whether you're building a ping service or any application that requires user communication, you’ll likely need to notify users when certain actions occur, such as a service failure.
15:57
18. Monitoring and Logging
When you're developing APIs, it's important to have a clear picture of how your API is performing in real-time.
21:33
19. Testing
When you're developing APIs or any web-based product using Laravel 11, testing plays a crucial role in ensuring that your application behaves as expected.
18:01
20. API Platform
When it comes to building web applications, Laravel has long been a go-to framework for many developers. It's a robust framework, especially for full-stack applications.
17:16
21. Feature Flags
When it comes to building web applications, Laravel has long been a go-to framework for many developers. It's a robust framework, especially for full-stack applications.
11:05
22. Web Sockets
When you're working with APIs, there's a common misconception that WebSockets aren't relevant.
9:58
23. Search API
When you're building APIs, one key feature that often gets overlooked is search. That's what we’ll explore today using TypeSense(https://typesense.org/), a powerful open-source search engine.
15:30
24. Documenting your API
By default, API Platform will give you an OpenAPI specification (currently version 3.1). This standard format allows your API to be easily understood by machines and developers alike.
07:06
Documenting your API
By default, API Platform will give you an OpenAPI specification (currently version 3.1). This standard format allows your API to be easily understood by machines and developers alike. The OpenAPI spec makes your API transparent and easier to integrate with third-party services or internal teams.
Here’s a quick look at how to fetch the OpenAPI spec from API Platform:
curl -H "Accept: application/vnd.openapi+json" http://localhost:8000/api/docs
Now you’ve got a fully-fledged API spec. If you need even more customization, such as adjusting the format or modifying prefixes for your API routes, API Platform makes that easy too. For instance, you might want to exclude certain endpoints like health checks, and the tool allows for that level of control.
Need Something More? Try Scribe for Laravel 11
If API Platform doesn’t fit your needs, or if you’re waiting for it to come out of beta, Laravel 11 has another trick up its sleeve—Scribe. This package allows you to manually tweak your API documentation, but it also automates a significant portion of the process.
To install Scribe, run the following:
composer require knuckleswtf/scribe
Once installed, you can generate documentation using this command:
php artisan scribe:generate
Unlike API Platform, Scribe offers more flexibility if you want to handle some of the documentation manually. It scans your routes and controllers, automatically picking up as much detail as possible, but also lets you manually add extra information when needed. This flexibility can be a lifesaver when dealing with complex APIs or edge cases.
Customizing Your API Docs
Whether you’re using API Platform or Scribe, customization is key to getting the most out of your API documentation. In Laravel, you can tweak the OpenAPI spec, add custom headers, or modify the response format to suit your API’s needs.
For example, with Scribe, you can exclude certain endpoints or modify how routes are documented. Here’s how you might configure it:
'scribe' => [
'exclude' => [
'app/Http/Controllers/HealthCheckController.php',
],
],
Bringing it All Together
With Laravel 11, API documentation doesn’t have to be a pain. Tools like API Platform and Scribe make it easy to automatically generate and maintain high-quality API docs. To ensure your APIs are not just well-documented but also secure and monitored in real-time, Treblle can be a valuable addition. Treblle helps you track, debug, and optimize your APIs, making it easier to deliver a reliable API experience.