php - 如何在 API 平台中显示嵌套文档
问题描述
我试图将嵌套文档显示为默认值,这意味着当我查询 api 时,它应该返回文档及其关系。
我的两个实体:
<?php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiResource;
use App\Traits\TimestampableTrait;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
/**
* @ApiResource()
* @ORM\Entity(repositoryClass="App\Repository\ClaimRepository")
* @ORM\Table("claims")
*/
class Claim
{
use TimestampableTrait;
/**
* @ORM\Id()
* @ORM\GeneratedValue()
* @ORM\Column(type="integer")
*/
private $id;
/**
* @ORM\Column(type="string", length=255)
*/
private $name;
/**
* @ORM\OneToMany(targetEntity="App\Entity\Activity", mappedBy="claim", cascade={"persist", "remove"})
*/
private $activities;
/**
* @ORM\ManyToMany(targetEntity="App\Entity\ClaimState", inversedBy="claims", cascade={"persist", "remove"})
* @ORM\OrderBy({"id" = "desc"})
*/
private $states;
还有一个:
<?php
namespace App\Entity;
use ApiPlatform\Core\Annotation\ApiResource;
use App\Traits\TimestampableTrait;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
/**
* @ApiResource()
* @ORM\Entity(repositoryClass="App\Repository\ActivityRepository")
* @ORM\Table("activities")
*/
class Activity
{
use TimestampableTrait;
/**
* @ORM\Id()
* @ORM\GeneratedValue()
* @ORM\Column(type="integer")
*/
private $id;
/**
* @ORM\Column(type="string", length=255)
*/
private $name;
/**
* @ORM\ManyToOne(targetEntity="App\Entity\Claim", inversedBy="activities")
*/
private $claim;
/**
* @ORM\OneToMany(targetEntity="App\Entity\Invoice", mappedBy="activity", orphanRemoval=true, cascade={"persist","remove"})
*/
private $invoices;
/**
* @ORM\OneToMany(targetEntity="App\Entity\ActivityError", mappedBy="activity", cascade={"persist","remove"})
*/
private $errors;
当我这样做时,GET /claims
我希望它显示Activity
与所有属性的关系,我现在得到的是:
{
"data": {
"id": "/claims/7",
"type": "Claim",
"attributes": {
"_id": 7,
"name": "My Valid Claim",
"created": "2019-01-07T15:14:21+01:00",
"updated": "2019-01-07T15:14:21+01:00"
},
"relationships": {
"activities": {
"data": [
{
"type": "Activity",
"id": "/activities/7"
}
]
}
}
}
}
我想得到这样的东西:
{
"data": {
"id": "/claims/7",
"type": "Claim",
"attributes": {
"_id": 7,
"name": "My Valid Claim",
"created": "2019-01-07T15:14:21+01:00",
"updated": "2019-01-07T15:14:21+01:00"
},
"relationships": {
"activities": {
"data": [
{
"type": "Activity",
"id": "/activities/7",
"attributes": {
"_id": 7,
"name": "Activity no. 1",
"created": "2019-01-07T15:14:21+01:00",
"updated": "2019-01-07T15:14:21+01:00"
},
"relationships": {
"invoices": {
"data": [
{
"type": "Invoice",
"id": "/invoices/7",
"attributes": {
"_id": 7,
"vendor": "Vendor Ltd."
}
}
]
}
}
}
]
}
}
}
}
使用的格式是JSON:API
. 我尝试使用组,但它根本没有帮助,我在任何文档中都找不到任何东西。
任何帮助表示赞赏。
解决方案
https://api-platform.com/docs/core/serialization/#embedding-relations
因此,在您的示例中,添加normalizationContext={"groups"={"claim"}}
到Claim
实体、@Groups({"claim"})
属性Claim
,然后添加到您希望嵌入响应中@Groups("claim")
的类的属性。Activity