Solution: Describing APIs
Explore how to document API designs by creating comprehensive ALPS files. Learn to organize properties, containers, and actions into machine-readable formats, and manage your API description through version control and Git integration.
The exercise is to use the assets we created before (shown in the terminal below). This allows us to create a complete API description document in the Application-Level Profile Semantics (ALPS) format. This involves collecting all the properties and actions in our design document and coding them into the ALPS machine-readable format.
Using the ALPS JSON starter file
When we open the ALPS JSON starter file for this exercise (credit-check-alps.json), we’ll see all of the top-level elements we’ll need for this solution: alps, title, and doc. There’s nothing to add there. We’ll also see the top-level ...