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

# Newman

Now that we have built some API tests with Postman, it’s time to move from the Postman UI to a command-line interface. While the UI is nice, the CLI lets us run tests from simple scripts, quickly launch them, and make it easier to incorporate test runs into our regular development habits.

To run Postman tests, we can use a CLI utility called **Newman**, which is a tool created by the Postman team. It supports running test collections directly from the command line and outputting the results for viewing or storing within our project. Once we have Newman, we’ll need to pull one of our test collections from Postman and save it locally.

# Exporting a Postman collection
The first step to running tests locally is to export an existing test collection from the Postman application to our workstation. To do that, let’s open the Postman client and locate a collection to export in the left sidebar. For this example, let’s pick the “Company Home API Tests” collection we were using earlier.

To start the export, click the three dots next to the collection name to bring up the dropdown menu. Select “Export” from the menu to call up the “Export Collection” dialog box, as shown in the following screenshot:


Learn how to run Postman tests locally with Newman.

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

Running Tests Locally with Newman

Newman