Gain insights into designing robust APIs, explore essential tools for design, documentation, testing, and deployment. Delve into ALPS, OpenAPI, Postman, and Heroku for comprehensive API development.

Design and Build Great Web API's by The Pragmatic Programmer-01.png

webapis.tar.gz

Testing APIs

Testing API Exercise

Building API Exercise

Building API Exercise Solution

Securing API Exercise

Securing API Exercise Solution

MockAPI

Account Mock API

Company service Mock API

Challenge-1 Mock API Solution

Postman Mock API

At the start of this course, you’ll be introduced to a handful of important practices and principles for designing and building APIs that are robust, reliable, and resilient. You’ll also acquire skills in a wide range of developer tools, including tools for design, documentation, building, testing, security, and deployment. 

You'll learn the best practices for modeling an APIs lifecycle using Donald Norman’s action lifecycle. Then, you’ll learn how to use the sequence diagram for designing APIs and describing them using ALPS. For sketching an API, you will learn about Gehry's sketches. You will also cover OpenAPI and SwaggerHub for API mocking. Moreover, the usage of DARRT and NodeJS will be covered for building APIs. You'll finish with learning how to use the Postman for testing APIs and then deploy them using Heroku.

By the end of this course, you will have an in-depth understanding of how to make fully functional efficient APIs from its inception to its deployment.

Design and Build Great Web APIs

## Exercise
In this exercise, convert the Credit-Check sketch into an API prototype using the OpenAPI Specification format. Create a working prototype of the Credit-Check API that can be used as a reference.

1. To start, log in to the WSD editor at https://www.websequencediagrams.com to create a new WSD document that reflects the translation of `credit-check-alps` and `credit-check-diagram.wsd` into an HTTP-style API. This is the creative part of this challenge. There’s no right or wrong answer. Once you’re done, export your PNG and text versions of the WSD diagram.


> **Note:** You can see `credit-check-alps.json` and `credit-check-diagram.wsd` in the terminal below by executing the `cat <file-name>` command.

2. Next, log in to your account at SwaggerHub (https://swaggerhub.com) and start a new version 3 OAS document named `creditcheck-api` using the same defaults we used previously. Next, using the components template and the path template, fill out the Credit-Check prototype with all the parameters, request bodies, responses, and schemas that’ll be needed to complete the `paths` section of the OAS document. When you’re done with this step, you should have a fully defined Credit-Check API.


3. Next, use the SwaggerHub mocking service to run some simple tests on your interface. If needed, perform any minor bug fixes or interface changes. Once you are done making any changes to the OAS document, export the API definition as both a “YAML Unresolved” and a “YAML Resolved” output. Extract the JSON and YAML documents from the ZIP file and, along with the unresolved YAML file.


4. Finally, set up a folder for your API technical documentation and use the ReDocly HTML template (https://github.com/Redocly/redoc) to create your own interactive API documentation for your Credit-Check API.



# Exercise
In this exercise, convert the Credit-Check sketch into an API prototype using the OpenAPI Specification format. Create a working prototype of the Credit-Check API that can be used as a reference.

1. To start, log in to the WSD editor at https://www.websequencediagrams.com to create a new WSD document that reflects the translation of `credit-check-alps` and `credit-check-diagram.wsd` into an HTTP-style API. This is the creative part of this challenge. There’s no right or wrong answer. Once you’re done, export your PNG and text versions of the WSD diagram.


> **Note:** You can see `credit-check-alps.json` and `credit-check-diagram.wsd` in the terminal below by executing the `cat <file-name>` command.

2. Next, log in to your account at SwaggerHub (https://swaggerhub.com) and start a new version 3 OAS document named `creditcheck-api` using the same defaults we used previously. Next, using the components template and the path template, fill out the Credit-Check prototype with all the parameters, request bodies, responses, and schemas that’ll be needed to complete the `paths` section of the OAS document. When you’re done with this step, you should have a fully defined Credit-Check API.


3. Next, use the SwaggerHub mocking service to run some simple tests on your interface. If needed, perform any minor bug fixes or interface changes. Once you are done making any changes to the OAS document, export the API definition as both a “YAML Unresolved” and a “YAML Resolved” output. Extract the JSON and YAML documents from the ZIP file and, along with the unresolved YAML file.


4. Finally, set up a folder for your API technical documentation and use the ReDocly HTML template (https://github.com/Redocly/redoc) to create your own interactive API documentation for your Credit-Check API.



Practice converting the Credit-Check sketch into an API prototype using the OpenAPI Specification format.


Challenge: Prototyping APIs

Practice converting the Credit-Check sketch into an API prototype using the OpenAPI Specification format.

Introduction

Understanding HTTP, REST, and APIs

Modeling APIs

Designing APIs

Describing APIs

Sketching APIs

Prototyping APIs

Building APIs

Build a Rest API for an Image-Sharing App With Node.js

Testing APIs

Securing APIs

Deploying APIs

Deploying a Web Application to Heroku Using CLI

Modifying APIs

Some Parting Thoughts

Appendixes

Challenge: Prototyping APIs

Exercise