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

## Solution

The challenge was to use the curl command-line tool to pull a series of responses from three related services (Company, Account, and Activity) and save them to the disk for later reference. 
1. First, move to the folder called `services`.

2. Modify the API name in **line-2** of `index.js` file. Currently, we have written  `./company-home`. You can update it to any filename that is provided in the same services folder.

3. Click on "Run" button for that particular API.

4. Click on "+" icon to add another terminal.

5. Execute the following command in new terminal to save the API response in a new file `company-home.json`.
```
curl https://ed-5556326259752960.educative.run > company-home.json
```
> **Note:** Use your own (URL generated after running the code is different for each learner on educative platform) API URL in above command. 
The output is shown below:

```
% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   399  100   399    0     0   1291      0 --:--:-- --:--:-- --:--:--  1291
```
The resulting data saved in the `company-home.json` file looks like this:
`
{"home" : {"name":"company", "rel" : "collection", "href":"/company/list/"}}
`

> **Note:** You can modify file name for each API call.
6. To verify, execute `ls` command. You'll see the list of files that have been created and saved.

7. To see the file's content (API response), execute `cat file-name`.

Repeat the same process for all the provided API calls. 

This challenge has a total of seven URLs. When we’re done calling all of them, we should have a list of files that looks like this:
```
account-list.json 
account-record.json 
activity-list.json 
activity-record.json 
company-home.json 
company-list.json 
company-record.json
```
You can see the list of created documents by executing the `ls` command.


# Solution

The challenge was to use the curl command-line tool to pull a series of responses from three related services (Company, Account, and Activity) and save them to the disk for later reference. 
1. First, move to the folder called `services`.

2. Modify the API name in **line-2** of `index.js` file. Currently, we have written  `./company-home`. You can update it to any filename that is provided in the same services folder.

3. Click on "Run" button for that particular API.

4. Click on "+" icon to add another terminal.

5. Execute the following command in new terminal to save the API response in a new file `company-home.json`.
```
curl https://ed-5556326259752960.educative.run > company-home.json
```
> **Note:** Use your own (URL generated after running the code is different for each learner on educative platform) API URL in above command. 
The output is shown below:

```
% Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   399  100   399    0     0   1291      0 --:--:-- --:--:-- --:--:--  1291
```
The resulting data saved in the `company-home.json` file looks like this:
`
{"home" : {"name":"company", "rel" : "collection", "href":"/company/list/"}}
`

> **Note:** You can modify file name for each API call.
6. To verify, execute `ls` command. You'll see the list of files that have been created and saved.

7. To see the file's content (API response), execute `cat file-name`.

Repeat the same process for all the provided API calls. 

This challenge has a total of seven URLs. When we’re done calling all of them, we should have a list of files that looks like this:
```
account-list.json 
account-record.json 
activity-list.json 
activity-record.json 
company-home.json 
company-list.json 
company-record.json
```
You can see the list of created documents by executing the `ls` command.


Let's try to make API calls with curl to save responses to the disk.

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

Solution: API Calls with curl

Solution