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

## Steps of the API design method
An important way to bring consistency and compatibility to our APIs is to use a common design method or process. Doing this means all API designers go through a similar process, answer the same basic questions, provide recognizable solutions, and end up creating common results. These similarities make it easier for developers and other people involved in the work of building and releasing the API. When the time comes for others to use our API, they’ll recognize similar design details and common implementation elements from other APIs they’ve already used within the company.

The process described below is the one that has been used for many years with good success. It assumes that we’ve gathered lots of information from the key stakeholders, we have copies of the forms and worksheets, and we’ve built up simple flow diagrams and other assets. With all that in hand, it’s now time to turn our interviews and information into an API design.

This API design method consists of four steps:
1. **Descriptor:** Review all the names of the data and action elements and, where needed, convert them into the names already understood in the API program.
2. **Diagram:** Convert notes on workflow and internal cycles into something visual people can understand.
3. **Definition:** Create a machine-readable API definition document that developers can use as a starting point for their implementation.
4. **Documentation:** Write basic reference documentation for both service developers and service consumers (those using the API in the future).


# Steps of the API design method
An important way to bring consistency and compatibility to our APIs is to use a common design method or process. Doing this means all API designers go through a similar process, answer the same basic questions, provide recognizable solutions, and end up creating common results. These similarities make it easier for developers and other people involved in the work of building and releasing the API. When the time comes for others to use our API, they’ll recognize similar design details and common implementation elements from other APIs they’ve already used within the company.

The process described below is the one that has been used for many years with good success. It assumes that we’ve gathered lots of information from the key stakeholders, we have copies of the forms and worksheets, and we’ve built up simple flow diagrams and other assets. With all that in hand, it’s now time to turn our interviews and information into an API design.

This API design method consists of four steps:
1. **Descriptor:** Review all the names of the data and action elements and, where needed, convert them into the names already understood in the API program.
2. **Diagram:** Convert notes on workflow and internal cycles into something visual people can understand.
3. **Definition:** Create a machine-readable API definition document that developers can use as a starting point for their implementation.
4. **Documentation:** Write basic reference documentation for both service developers and service consumers (those using the API in the future).


Learn about the API design method through descriptors, diagrams, definitions, and documentation.


The API Design Method

Learn about the API design method through descriptors, diagrams, definitions, and documentation.

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

The API Design Method

Steps of the API design method