This talk was presented at API The Docs Virtual 2020 event series on 22 April. We are glad to present the video recording, slide deck and talk summary below. Enjoy!
Visit the API The Docs 2020 recaps overview to explore all presentations from 2020. API the Docs Virtual begins May 2021! CFP closes February 28, 2021.
Build something that people need.
Bring everything and everybody in (end users, design, data, product, ...) to understand the problem to solve. Think about business strategy (also for internal APIs!).
Navigate broad pieces easily, understand the major steps.
Have ideas about who your customers are, who you are trying to serve. Create different journeys. Find the balance between the developers’ mental models and the industry of the business they are working in.
Correct underneath structures.
Think through the structure of the API request & response body. Get a basic outline of each endpoint.
Tweak the final bits, find perfection.
Decide on the fine details. Use usability testing techniques.
Usability testing via Postman or Swagger. Needed: clear steps and moderation guide.
Just as with new APIs: iterate! Don’t let an already-built API stop you from building the right API.