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, you need to create sketches for the Credit-Check service. Starting from the diagram shown below, use Apiary Editor to create a number of sketches.


1. Create a simple HTML sketch that just contains the URL resources for the API, with notes on what will appear for each resource. Don’t worry about filling in the resource pages with data; just define each resource to support the HTTP GET request. This sketch should give you an idea of the number of URLs you’ll need when you finally code your API.

2. Create a new sketch that uses the JSON format. In this sketch, define a resource that lists credit-check records (`/list`) and a resource that displays a single `ratingItem` record (`/list/123`). Focus on including all the properties that need to appear for a `ratingItem` record and what that would look like in response. Don’t worry about links to any other resource—just sketch these two outlined above. This sketch should give a pretty good idea of what a detailed JSON response would look like for our API.

3. For both sketches, be sure to use Apiary Mock Server to test these out using the browser.


You can see the supporting documents below:


Practice creating some sketches for the Credit-Check service.


Challenge: Sketching APIs

Practice creating some sketches for the Credit-Check service.

Introduction

Understanding HTTP, REST, and APIs

Modeling APIs

Designing APIs

Describing APIs

Sketching APIs

Prototyping APIs

Building APIs

Testing APIs

Securing APIs

Deploying APIs

Modifying APIs

Some Parting Thoughts

Appendixes

Challenge: Sketching APIs

Exercise