Skip to content

Commit e33b3cb

Browse files
committed
docs: describe use of pydantic
1 parent 77eab2c commit e33b3cb

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# 9. Use pydantic for JSON (de-)serialization
2+
3+
Date: 2020-06-09
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
In order to interact with a remote workspace, for example, at structurizr.com.
12+
The remote or local workspace has to be (de-)serialized from or to JSON.
13+
14+
## Decision
15+
16+
In order to perform these operations we choose
17+
[pydantic](https://pydantic-docs.helpmanual.io/) which has a nice API, active
18+
community, good data validation, helpful documentation, and good performance.
19+
20+
## Consequences
21+
22+
We separate the models representing Structurizr entities and their business
23+
logic from how those models are (de-)serialized. That means that for each model
24+
we have a corresponding IO pydantic model describing the JSON data model.
25+

0 commit comments

Comments
 (0)