The international conference on the API Platform Framework
Lear more about the event, register for the conference, and get ready for two days of inspiration, ideas, and knowledge-sharing with our incredible lineup of renowned specialists and advocates.
This edition is shaping up to be our biggest yet — secure your seat now at the best price before we sell out!
By default, API Platform generates all URLs as absolute paths to the base URL.
For instance, in JSON-LD, you will get a collection like this:
{
"@context": "/contexts/Book",
"@id": "/books",
"@type": "Collection",
"member": [
{
"@id": "/books/1",
"@type": "https://schema.org/Book",
"name": "My awesome book"
}
],
"totalItems": 1
}
You may want to use absolute URLs (for instance if resources are used in another API) or network paths instead.
It can be configured globally using one of the configurations below:
# api/config/packages/api_platform.yaml
api_platform:
defaults:
url_generation_strategy: !php/const ApiPlatform\Metadata\UrlGeneratorInterface::ABS_URL
<?php
// config/api-platform.php
return [
// ....
'defaults' => [
'url_generation_strategy' => ApiPlatform\Metadata\UrlGeneratorInterface::ABS_URL
],
];
It can also be configured only for a specific resource:
<?php
// api/src/ApiResource/Book.php with Symfony or app/ApiResource/Book.php with Laravel
namespace App\ApiResource;
use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\UrlGeneratorInterface;
#[ApiResource(urlGenerationStrategy: UrlGeneratorInterface::ABS_URL)]
class Book
{
// ...
}
# api/config/api_platform/resources.yaml
# The YAML syntax is only supported for Symfony
resources:
App\ApiResource\Book:
urlGenerationStrategy: !php/const ApiPlatform\Api\UrlGeneratorInterface::ABS_URL
<?xml version="1.0" encoding="UTF-8" ?>
<!-- api/config/api_platform/resources.xml -->
<!-- The XML syntax is only supported for Symfony -->
<resources
xmlns="https://api-platform.com/schema/metadata/resources-3.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
https://api-platform.com/schema/metadata/resources-3.0.xsd">
<resource class="App\ApiResource\Book" urlGenerationStrategy="0" />
</resources>
For the above configuration, the collection will be like this:
{
"@context": "http://example.com/contexts/Book",
"@id": "http://example.com/books",
"@type": "Collection",
"member": [
{
"@id": "http://example.com/books/1",
"@type": "https://schema.org/Book",
"name": "My awesome book"
}
],
"totalItems": 1
}
You can also help us improve the documentation of this page.
Made with love by
Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.
Learn more