web-api-style
web-api-style copied to clipboard
Low-barrier to entry for API developers
Suggested by Mike Amundsen
HTML is a "low-barrier" to entry for document developers. it's even turned into a low-barrier for app developers (when adding JS).
what is the equivalent for API developers?
my observation is that "CRUD-applied-to-object" pattern seems to be a low barrier for API devs. almost everyone uses this to start and most everyone understands this pattern within minutes. it has scaling challenges (both at the domain and protocol level), but i suspect the pattern could be an important way to fulfill this requirement.
wonder how many other ways we can express this "low-barrier" for API devs....
We should aim at low-barrier to entry for:
- API providers (developers, managers, owners)
- API consumers (developers mostly)
- API middleware implementers
This could mean:
- dev-friendly media types (easy to create, parse)
- easy to consume in UI layer or in other APIs
- easy to test, experiment with
- reuse existing web protocols and standards (benefit from knowledge and existing tooling)
- ...