| title |
SampleAPIs Wiki |
| description |
Single-concept, 60-second pages documenting the SampleAPIs system |
| audience |
|
Documentation for SampleAPIs — a free, no-auth playground of RESTful sample APIs for learning. Each page covers one concept in about 60 seconds and links onward, wiki-style. Everything here is written against the current code; when a page names a file, the link goes to the source.
| Section |
What it covers |
| Architecture |
The two apps, the tech stack, and how a request flows |
| API Surface |
REST conventions, queries, CRUD, rate limits, errors, service routes |
| Endpoint Data |
The JSON datasets — format, registry, resets, custom endpoints |
| Client Features |
Routing, state, the Playground, styling |
| Operations |
Local dev, Docker, deployment, testing |
| Contributing |
Setup, code style, pull request flow |
| Decisions |
Why it's built this way — trade-offs and revisit triggers |
| Future Features |
Proposed features under consideration, one evaluable proposal per page |
| Implementation Roadmap |
Per-feature implementation plans and decision logs, with review status |
| Glossary |
Shared vocabulary — project terms defined once |
Every page has YAML front matter (title, description, audience), a breadcrumb back to its section, one concept in the body (with a Mermaid diagram where a picture explains it faster), source links under Key files, and onward links under Related. When a topic deserves more than a sentence of explanation, it gets its own page and an inline link — if you can't link to it, it isn't documented yet.