Part 1 Fundamentals of API design

 

Fundamental web API design skills include identifying capabilities that meet user needs, representing capabilities in an HTTP interface, and describing the interface in a blueprint. For example, suppose the “Define stage” output is “SOCNET API”: we must clarify the expected capabilities to avoid creating a design that doesn’t meet user needs. Once we agree with stakeholders on capabilities like “Sharing a status” and “List friends,” we can design a REST API interface with operations such as POST /statuses and GET /friends, which requires understanding REST API principles and HTTP. Discussing the design with stakeholders requires a formal description of the API. Using a standard API description format instead of a wiki page is recommended for streamlining discussions. It will also facilitate accurate implementation.