- template-target
- DesignRoutes
- template-levels
- pro, master
- template-note
- the designed API of a pro or master project, made when the project is created (P-605)
- description
- The API of {{project}} as designed: conventions and the routes each feature uses
- tags
- #ai #design #routes
- status
- draft
{{project}}: routes as designed¶
This is DesignRoutes, kept by the designer: the API conventions of {{project}} and the specific routes the design decided, per feature (the same {#id} as in Design). The routes as one code base built them are in its own …Routes topic. Its companions: Spec (what it does), SpecUi (how the UI behaves), Design (the mechanisms), DesignRoutes (the API) and SpecTest (the black-box tests); each code base that builds {{project}} keeps its own topics, named after it (e.g. Proto1Impl, Proto1Code, Proto1Routes, Proto1Test).
Goals¶
- Role: every route the design decided, with its request, answer and error codes.
- A line belongs here if a client of {{project}} would break when it changed.
- It fails if a route exists only in a code base's topics, or if it names how one code base serves it.