Skip to content

Commit 8c841e2

Browse files
committed
new english snippet for api delivery station api designin principles, i.e how to how to start the API Delivery work based on the previous "stations"
1 parent 1a78e28 commit 8c841e2

1 file changed

Lines changed: 70 additions & 0 deletions

File tree

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
## How to start the API Delivery work based on the previous "stations"
2+
3+
Use this guidance at the start of `API Delivery` after the contract and the key outputs from earlier stations have been reviewed and accepted.
4+
5+
The goal is not to invent implementation in isolation. The goal is to turn the agreed outputs from earlier stations into concrete code structure, validation rules, runtime behavior, and delivery decisions.
6+
7+
---
8+
9+
### 1. Start From The Validated Contract
10+
11+
- Treat the validated API contract as the main reference for implementation decisions.
12+
- Keep the contract and implementation aligned throughout delivery.
13+
- Use the contract to drive request validation, response mapping, documentation, and tests.
14+
15+
---
16+
17+
### 2. Use Domain Outputs To Preserve Business Meaning
18+
19+
- Use the `Domain Canvas` to guide naming, how the implementation is split into clear business responsibilities, and how different backend systems are connected without exposing their differences.
20+
- Preserve the validated meanings of entities, attributes, statuses, and source-of-truth rules.
21+
- Avoid leaking backend-specific models or inconsistencies into the public API.
22+
23+
---
24+
25+
### 3. Use Journey Outputs To Preserve Critical Flows
26+
27+
- Use the `Customer Journey Canvas` to identify which user flows are most important to support first.
28+
- Use the `API Consumer Experience` outputs to keep the API understandable, predictable, and easy to integrate.
29+
- Let the agreed journey priorities decide which implementation paths need the highest reliability, lowest latency, clearest errors, and strongest operational focus.
30+
31+
---
32+
33+
### 4. Use Value Proposition Outputs To Preserve Consumer Value
34+
35+
- Use the `API Value Proposition Canvas` to keep the implementation focused on the agreed pains, gains, and API features.
36+
- Preserve the field meanings, behavior, and promises that made the API valuable in the earlier stations.
37+
- Ensure error handling, freshness, and naming support both the intended developer experience and the business use case.
38+
39+
---
40+
41+
### 5. Use Architecture Outputs To Shape Runtime Decisions
42+
43+
- Use the `Business Impact Canvas` to guide resilience, timeout, fallback, and degradation decisions.
44+
- Use the `Locations Canvas` to guide network boundaries, trust boundaries, access paths, and deployment constraints.
45+
- Use the `Capacity Canvas` to guide rate limits, caching, scaling, and peak-load behavior.
46+
- Use the `API Metrics And Analytics` guidance to decide what must be observed from the first implementation onward.
47+
48+
---
49+
50+
### 6. Use Interaction And Protocol Design Outputs To Shape Code Structure
51+
52+
- Use the `Interaction Canvas` to avoid implementing unsupported interaction styles too early.
53+
- Use the `REST`, `Event`, or `GraphQL` design outputs to shape protocol-specific request, response, and validation behavior.
54+
- Reflect the selected interaction style clearly in code structure, responsibilities, and testing strategy.
55+
56+
---
57+
58+
### 7. Use Audit Outputs To Improve Delivery Before Coding Goes Too Far
59+
60+
- Use the audit findings to remove ambiguity before implementation spreads across the codebase.
61+
- Fix unclear request rules, missing validation, weak error contracts, and operational gaps early.
62+
- Treat audit as a design-improvement loop before production, not only as a final gate.
63+
64+
---
65+
66+
### 8. Apply The Guidance, Then Summarize
67+
68+
- Apply this guidance to the current API and implementation plan.
69+
- Summarize the implications for code structure, request validation, source integration, security, monitoring and alerts, and testing.
70+
- Do not create a separate delivery artifact unless the team or user specifically needs one.

0 commit comments

Comments
 (0)