Skip to content

Add XML and YAML DTOs config examples #790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 8, 2019
Merged

Add XML and YAML DTOs config examples #790

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1a176c
Add XML and YAML DTOs config examples
jbdelhommeau Apr 15, 2019
fe840ce
Update core/dto.md
Korbeil Apr 15, 2019
3395737
Update dto.md
jbdelhommeau Apr 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions core/dto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,34 @@ final class Book
}
```

Or using XML:

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<!-- api/config/api_platform/resources.xml -->

<resources xmlns="https://api-platform.com/schema/metadata"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://api-platform.com/schema/metadata
https://api-platform.com/schema/metadata/metadata-2.0.xsd">
<resource class="App\Entity\Book">
<attribute name="input">App\Dto\BookInput</attribute>
<attribute name="output">App\Dto\BookOutput</attribute>
</resource>
</resources>
```

Or using YAML:

```yaml
# api/config/api_platform/resources.yaml
resources:
App\Entity\Book:
attributes:
input: App\Dto\BookInput
output: App\Dto\BookOutput
```

The `input` attribute is used during [the deserialization process](serialization.md), when transforming the user-provided data to a resource instance.
Similarly, the `output` attribute is used during [the serialization process](serialization.md). This class represents how the `Book` resource will be represented in the `Response`.

Expand Down