| title | description | author | ms.author | ms.topic | ms.date |
|---|---|---|---|---|---|
Build API clients for PHP |
Learn how use Kiota to build API clients in PHP. |
jasonjoh |
jasonjoh |
quickstart |
03/24/2023 |
In this tutorial, you build a sample app in PHP that calls a REST API that doesn't require authentication.
Run the following commands in the directory where you want to create a new project.
composer initIn case you're adding a Kiota client to an existing project, the following configuration is required:
- composer.json > require > php set to "php": "^8.0 || ^7.4" or later.
Before you can compile and run the generated API client, you need to make sure the generated source files are part of a project with the required dependencies. Your project must have a reference to the abstraction package. Additionally, you must either use the Kiota default implementations or provide your own custom implementations of the following packages.
- HTTP (Kiota default Guzzle-based implementation)
- JSON serialization (Kiota default)
- Text serialization (Kiota default)
For this tutorial, use the default implementations.
Run the following commands to get the required dependencies.
composer require microsoft/kiota-abstractions
composer require microsoft/kiota-http-guzzle
composer require microsoft/kiota-serialization-json
composer require microsoft/kiota-serialization-textKiota generates API clients from OpenAPI documents. Create a file named posts-api.yml and add the following.
:::code language="yaml" source="~/code-snippets/get-started/quickstart/posts-api.yml":::
This file is a minimal OpenAPI description that describes how to call the /posts endpoint in the JSONPlaceholder REST API.
You can then use the Kiota command line tool to generate the API client classes.
kiota generate -l PHP -d ../posts-api.yml -c PostsApiClient -n KiotaPosts\Client -o ./clientTip
Add --exclude-backward-compatible
if you want to reduce the size of the generated client and are not concerned about
potentially source breaking changes with future versions of Kiota when updating the client.
Add the following to your composer.json to set your namespaces correctly:
"autoload": {
"psr-4": {
"KiotaPosts\\Client\\": "client/"
}
}To ensure the newly generated classes can be imported, update the autoload paths using:
composer dumpautoloadCreate a file in the root of the project named main.php and add the following code.
:::code language="php" source="~/code-snippets/get-started/quickstart/php/main.php" id="ProgramSnippet":::
Note
The JSONPlaceholder REST API doesn't require any authentication, so this sample uses the AnonymousAuthenticationProvider. For APIs that require authentication, use an applicable authentication provider.
To start the application, run the following command in your project directory.
php main.php- kiota-samples repository contains the code from this guide.
- Microsoft Graph sample using Microsoft identity platform authentication
- ToDoItem Sample API implements a sample OpenAPI in ASP.NET Core and sample clients in multiple languages.