Summary
Explore methods for documenting API designs using ALPS to create both human- and machine-readable formats. Understand implementation-agnostic descriptions, organize API vocabularies, and apply ontologies like Schema.org to normalize data. Learn to visualize API designs with sequence diagrams, preparing you to build APIs effectively from detailed, well-structured descriptions.
We'll cover the following...
We'll cover the following...
This chapter reviewed a number of things related to documenting our API design in both machine-readable and human-readable formats. Along the way, we covered the importance of implementation-agnostic description formats for converting our diagrams into other formats, and the difference between general description formats and ...