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 ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access