Design and Build Great Web APIs

Updating Your API Project

Now that we’ve created our ALPS description document for the Onboarding API and used the ALPS file to generate basic human-readable API documentation, it’s time to add these two important assets to our ongoing project. That means first adding them to the project repository and then updating the package.json file.

The first step is to make sure both the OnboardingAPI.yaml ALPS file and the OnboardingAPI.md API documentation files are copied to your local project folder. I keep these kinds of documents in a project subfolder named assets/. This is the folder I use to hold important files that aren’t required for the build or the runtime of the API. Your team may have another common place for these kinds of files, or you ...