5. Workshop steps
1. Things to think about before you start
2. Create your API contract
3. Document and share your API
6. API Design
What to think about before you start crafting your API contract
7. ● Is the API worth building?
● What problem does the API solve?
● How will the API be used?
● What API project methodology will we use?
API Design checklist
20. Identify resources
What’s a resource?
“A network data object or service that
can be identified by a URI [...].
Resources may be available in multiple
representations (e.g. multiple
languages, data formats, size, and
resolutions) or vary in other ways.”
RFC 2616 (june 1999)
21. What’s a resource? Second attempt!
Identify resources
“A resource is anything that’s important
enough to be referenced as a thing in itself.”
Leonard Richardson & Sam Ruby
- “Restful Webservices”
22. Define operations
“Actions that can be performed on
your resources.
The most common operations are GET,
POST, PUT, PATCH and DELETE.”
What’s an operation?
30. Prepare documentation
● Add general information: endpoints, security, a picture
● Structure your API via sections
● Complete documentation with additional information
on error handling and authentication
33. Next steps
● Share your API design and get feedback on it
● Use Client SDK to speed up mobile app development
● Bootstrap your server code with Server Skeletons
● Export a Swagger file if you need to