Solution: Prototyping APIs

This challenge contained instructions to first create a new WSD document that reflects a translation of the Credit-Check WSD diagram and the Credit-Check ALPS description document into an HTTP-style API. Then, take that WSD and produce a completed API definition document using SwaggerHub and the OAS format. Finally, we needed to combine the ReDocly HTML template and our completed Credit-Check API definition (in JSON format) to produce single-page interactive API documentation for our API.

HTTP-style WSD file

The first step is to come up with the HTTP-style diagram of our initial API design. As we learned previously, the act of converting the design documents (WSD and ALPS) into an implementation document (OAS) is an art, not a science. There are lots of possible solutions. The diagram shown below is the one we created. We can use it as a guide and compare it with the one we came up with: