Ship types, not docs
shiptypes.com · 2,793 words · saved by 1 readers
Types are the contract between services, docs are not
Ship types, not docs Ship types , not docs Types are the contract between services, docs are not by Boris Tane Documentation v2 · 4 months ago POST /api/v2/orders userId : string optional items : Item[] amount : string address : object zipCode : number street : string user_name : string // No mention of required headers // No mention of currency field // Last updated by @sarah (left the company) Implementation v3 · current // requires X-Api-Version header app . post ( '/api/ v3 /orders' , async (req, res) => { const { customerId , items, amount, address, currency } = req.body; //
saved by
related reading
- Shipping at Inference-Speed | Peter Steinbergersteipete.me
- Building Effective AI Agents \ Anthropicanthropic.com
- Everything I know about good API designseangoedecke.com
- The Surprising Power of Documentationnews.ycombinator.com
- How Stripe creates the best documentation in the industrymintlify.com
- Don’t Outsource Your Thinkingteltam.github.io
- APIs All the Way Down - Not Boring by Packy McCormicknotboring.co
- Thoughts on slowing the fuck downmariozechner.at
- Cookbookcookbook.openai.com
- TypeScript: Documentation - The Basicstypescriptlang.org
- DevDocs API Documentationdevdocs.io
- Bulletproof node.js project architecture 🛡️softwareontheroad.com