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

In this chapter, we focused on translating the final API prototype into an actual working implementation of the Onboarding API. To do that, we used a simple API library called DARRT that was built with Node.js, an Express.js HTTP library, and the EJS template library.

The DARRT library leads developers to translate designs into five parts: data, actions, resources, representations, and transitions. The first three parts are common in all web API approaches. The last two are added to improve the quality of the implementation, especially to support the use of links and forms. Moreover, we also covered how links and forms make up the distinguishing elements of APIs that are built using the principles of web development.


Review what we have covered in this chapter.


Summary

Review what we have covered in this chapter.

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

Summary