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

## Overview

In this lesson, we’ll write up a sad-path test for the BigCo API. For example, let’s create a test that confirms we can’t add a new company record if we’re missing required properties.

First, we can add a new request to the Company API Home Tests collection. From the main Postman interface, click the three dots near the collection name in the left sidebar and select “Add Request” from the dropdown menu. In the dialog box that appears, type “Company Create (missing properties)” as the request name and click the “Save” button.

You’ll now see the new request added to the collection (in the left sidebar). Click that request to bring it into the main editor and enter the following in the “Request URL” field: `http://company-atk.herokuapp.com`. Also, select `POST` from the drop-down menu to the left of the URL. Save this request to your collection and click the “Send” button to confirm that the request actually works. We should see an error message in the “Body” tab of the main display telling us the request has been completed as expected.

## Writing tests
Now it’s time to write the tests. Click the “Tests” tab under “Request URL” field and add the following text in the editor:


# Overview

In this lesson, we’ll write up a sad-path test for the BigCo API. For example, let’s create a test that confirms we can’t add a new company record if we’re missing required properties.

First, we can add a new request to the Company API Home Tests collection. From the main Postman interface, click the three dots near the collection name in the left sidebar and select “Add Request” from the dropdown menu. In the dialog box that appears, type “Company Create (missing properties)” as the request name and click the “Save” button.

You’ll now see the new request added to the collection (in the left sidebar). Click that request to bring it into the main editor and enter the following in the “Request URL” field: `http://company-atk.herokuapp.com`. Also, select `POST` from the drop-down menu to the left of the URL. Save this request to your collection and click the “Send” button to confirm that the request actually works. We should see an error message in the “Body” tab of the main display telling us the request has been completed as expected.

# Writing tests
Now it’s time to write the tests. Click the “Tests” tab under “Request URL” field and add the following text in the editor:


Learn how to write a sad-path test in Postman.

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

Writing a Sad-Path Test in Postman

Overview