API Sketching Tips and Tricks

Learn about the tips and tricks for sketching APIs.

Sketching APIs in HTML

Previously, we used HTML for one of our early sketches. It makes it easy for us to visualize the way resources connect to each other, and it also makes it possible for us to use Apiary Mock Server to share a user-friendly rendering of our sketch with other stakeholders on our team, with our clients, and so forth.

For example, here’s the Onboarding Record sketch in HTML. This is the resource that supports all the actions, like addCompanyInfo, addAccountInfo, addActivityInfo, approveOnboarding, and rejectOnboarding:

Get hands-on with 1200+ tech skills courses.