How to write laravel api

With the development of Internet applications and mobile applications, many companies and developers have begun to adopt an architecture that separates the front and back ends. The back end provides RESTful APIs for the front end to use. How to write APIs quickly and efficiently has become a concern for many developers. . Laravel is a popular PHP web framework that provides complete routing, ORM, middleware and other components, making it extremely easy to write APIs. This article will explore how to write RESTful APIs in the Laravel framework.

1. Installing and configuring the Laravel framework

First you need to install the Laravel framework, which can be downloaded through Laravel’s official website or composer:

composer create-project --prefer-dist laravel/laravel api

Then configure it. You can configure database, cache, queue and other components in the .env file. For convenience, you can configure the database information in the .env file:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=api
DB_USERNAME=root
DB_PASSWORD=

and add the database information in the config/database.php file:

'mysql' => [
    'driver' => 'mysql',
    'host' => env('DB_HOST', '127.0.0.1'),
    'port' => env('DB_PORT', '3306'),
    'database' => env('DB_DATABASE', 'forge'),
    'username' => env('DB_USERNAME', 'forge'),
    'password' => env('DB_PASSWORD', ''),
    'charset' => 'utf8mb4',
    'collation' => 'utf8mb4_unicode_ci',
    'prefix' => '',
    'strict' => false,
    'engine' => null,
],

2. Design API interface

Before writing the API, you need to determine the function of the API and the required request parameters and response data. This step is very important and determines how the API is used and how it is used. Effect. For example, suppose we want to write an API to obtain a product list, then we need the following information:

• Request method: GET
• Request URL:/api/products
• Request parameters: No parameters required
• Response data: Product list

Here is an example:

use AppProduct;

Route::get('/api/products', function () {
    return Product::all();
});

In this example, we use Laravel The routes and models that come with the framework first define a GET requested URL address /api/products in the routing file, and then return all the URLs in the corresponding controller method. Product data. Here we use ORM (Object Relational Mapping) to operate the database, which can quickly and conveniently perform data operations.

3. Use of middleware

Middleware is an important concept in the Laravel framework. It can perform some operations, such as identity, before or after the request reaches the controller method. Verification etc. When writing an API, you usually need to add some middleware to ensure the security and performance of the API.

For example, we can add a middleware to verify the header information of the request, such as API version, whether the Token is legal, etc., and then query and return data in the controller method. The sample code is as follows:

use AppHttpMiddlewareVerifyApiToken;
use AppHttpMiddlewareVerifyApiVersion;

Route::middleware([VerifyApiToken::class, VerifyApiVersion::class])->group(function () {
    Route::get('/api/products', function () {
        return Product::all();
    });
});

In this example, we added two middlewares VerifyApiToken and VerifyApiVersion through the middleware method, they will Executed before the request reaches the controller method to ensure the security and version consistency of the request.

4. Exception handling

Exception handling is also an important link when writing APIs. It allows us to better capture and handle exceptions, such as input parameter errors. , the query data does not exist, etc. In the Laravel framework, we can handle exceptions uniformly through the AppExceptionsHandler class.

For example, suppose we want to implement an API to obtain a single product, and return a 404 status code and error message when the product does not exist. The code example is as follows:

Route::get('/api/products/{id}', function ($id) {
    $product = Product::find($id);
    if (!$product) {
        abort(404, '商品不存在');
    }
    return $product;
});

In this example, we query product data through the find method. If the query result is null, use abort# directly. ##Method returns 404 status code and error message. By using exception handling, we can make our API more robust and stable.

Finally

Through the above steps, we can start writing our own RESTful API. The Laravel framework provides complete routing, middleware, ORM and other components, making API writing very simple and efficient. Of course, there are many more detailed and professional API writing guides. I hope this article can provide readers with reference and inspiration.

The above is the detailed content of How to write laravel api. For more information, please follow other related articles on the PHP Chinese website!