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

For this exercise, you’re required to create a Postman test collection for the Credit-Check API we built previously. After creating a new collection and adding both happy- and sad-path tests, run them to validate the API.

# Write the Credit-Check Postman test collection

First, fire up the Postman client and create a new collection called “Credit-Check”. Then create the following two test entries:

## Happy-path: Test the `home` resource

- Request URL: `http://localhost:8181/`
- Method: `GET`
- Body: `None`
- Protocol Tests
  - HTTP status equals `200`
  - `content-type` includes `application/json`
- Structure Tests
  - `home` object at the root is an array
  - `home` has `id`, `name`, `href`, and `rel` properties
- Content Tests
  - `home.id` includes `list`
  - `home.name` includes `credit-check`
  - `home.rel` includes `credit-check` and `collection`


## Sad-path: Test the `form` resource

- Request URL: `http://localhost:8181/form/`
- Method: `POST`
- Body: None
- Protocol Tests
  - HTTP status equals `400`
  - `content-type` includes `application/problem+json`
- Structure Tests
  - `error` object at the root is an array
  - `error` has `type`, `title`, `detail`, `status`, and `instance` properties
- Value Tests
  - `type` contains `error`
  - `title` contains `Missing companyName`
`detail` contains `Missing companyName`
`status` contains `400`


Use the Postman client to add these two requests and write the test script using the Chai.js assertion library like we did earlier. Save the tests to Postman.

# Run the test with the Postman client
After writing and saving the tests, use the Postman client to run the tests and review the results.

# Terminal
1. Click the “Run” button in the widget below.
2. Execute the `npm run dev` command in the terminal.
3. Copy the link provided (for example, `https://6eqqkm56g2ewy.educative.run`) instead of `localhost:8181/` to use as a request URL in Postman.



Practice writing and running the Credit-Check Postman test collection.


Challenge: Testing APIs

Practice writing and running the Credit-Check Postman test collection.

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: Testing APIs

Exercise