Sample work · Software & Web Apps
API Design Review: Interface description checked and revised
A demo description in OpenAPI format with typical flaws: verbs in the path, lists without pagination, missing error responses, no authentication, dead references. The reviewer identifies them, the revised description passes.
Sample work (demo), not a client job. Built as a trial task with invented example data; the check figures below come from the automatic test run and are not polished.
What was built
- Paths name things, lists have pagination, POST responds with Created
- Every operation with operationId and error responses, common error format
- Authentication and version in the path, all references resolve
- Operation invented
How it was checked
Automatic test run on 2026-10-31, taken from the log (test data invented, figures measured):
- Demo interface: Before description 11 findings in 10 types, after 0
- Bad counter-test 7 findings
- 8 checks
Limits
What this sample does not cover, so nobody expects more:
- The description is checked, not the running service
- Contract tests against the actual service only with access and agreement
- Technical fields and versioning strategy are clarified by the client
Something like this for your business?
Describe briefly what you need. You get a fixed price before I start; nothing happens without your yes.