REST API design engagement
A fixed-scope consulting package that ends with an OpenAPI 3 specification, worked examples, and a recorded walkthrough for your implementers and partner developers.
Who this is for
- Product or engineering leads exposing a new REST surface to mobile apps, retailers, or municipal systems
- Teams where backend and partner developers will build in parallel and need a single contract
- Organisations that must document auth, rate limits, and error payloads before security review
What you receive
- Resource model with naming rationale and relationship diagram
- OpenAPI 3 document with request/response schemas and examples
- Error catalogue aligned to your observability tooling
- Versioning and deprecation policy draft
- 90-minute handover session (recorded) and two weeks of clarification email
What we do not include
Implementation in your codebase, load testing, penetration testing, and ongoing partner support are separate engagements. We can recommend specialists we have worked with in Gauteng if you need them.
Process and timeline
- Week 0 — Kickoff: Stakeholder interviews, access to existing docs, success criteria for integrators.
- Weeks 1–2 — Modelling: Draft resources, verbs, and pagination; review with your domain experts.
- Weeks 3–4 — Specification: OpenAPI draft, auth flows, webhook or callback patterns if required.
- Weeks 5–6 — Hardening: Partner-readiness review, example payloads, final delivery and recording.
Most engagements run remotely with two on-site workshops in Johannesburg when product owners prefer whiteboard work.
Pricing basis
Quoted per engagement from scope complexity—number of resources, auth model, and partner count. See rates for starting figures and what shifts the estimate.
Next step
Share your current diagram or product brief. We respond with a proposed timeline and fixed quote within three business days.
Request a scoping call