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

## Adding assets

Now that we’ve created our ALPS description document for the Onboarding API and used the ALPS file to generate basic human-readable API documentation, it’s time to add these two important assets to our ongoing project. That means first adding them to the project repository and then updating the `package.json` file.

The first step is to make sure both the `OnboardingAPI.yaml` ALPS file and the `OnboardingAPI.md` API documentation files are placed in our `onboarding-api` folder. We can keep these kinds of documents in a project subfolder named `assets`. This is the folder we use to hold important files that aren’t required for the build or the runtime of the API. Your team may have another common place for these kinds of files, or you may prefer to place them somewhere else. It’s up to you.

Once we place them in our project, we need to add them to our Git repository. Committing our Onboarding API files to the repository looks like this:
```xml
git add assets

git commit -m "add onboarding api assets"
```
Once they’ve been added to our repository, we can update our `package.json` file with Onboarding assets to include them, too.


# Adding assets

Now that we’ve created our ALPS description document for the Onboarding API and used the ALPS file to generate basic human-readable API documentation, it’s time to add these two important assets to our ongoing project. That means first adding them to the project repository and then updating the `package.json` file.

The first step is to make sure both the `OnboardingAPI.yaml` ALPS file and the `OnboardingAPI.md` API documentation files are placed in our `onboarding-api` folder. We can keep these kinds of documents in a project subfolder named `assets`. This is the folder we use to hold important files that aren’t required for the build or the runtime of the API. Your team may have another common place for these kinds of files, or you may prefer to place them somewhere else. It’s up to you.

Once we place them in our project, we need to add them to our Git repository. Committing our Onboarding API files to the repository looks like this:
```xml
git add assets

git commit -m "add onboarding api assets"
```
Once they’ve been added to our repository, we can update our `package.json` file with Onboarding assets to include them, too.


Learn how to add assets to an API project.

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

Updating an API Project

Adding assets