Design and Build Great Web APIs

What’s Next?

This chapter reviewed a number of things related to documenting your API design in both machine-readable and human-readable formats. Along the way we covered the importance of implementation-agnostic description formats for converting your diagrams into other formats, and the difference between general description formats and implementation-specific definition formats. We also reviewed both the Dublin Core Application Profile (DCAP) and the Application-Level Profile Semantics (ALPS) formats.

In addition, we worked through the process of describing our Onboarding API using ALPS. That included adding the title and general documentation text (​Starting from the Top​), adding all the vocabulary from our design session (​Adding Data ...