0% completed

All LessonsFree Lessons (1)

Introduction

Introduction to the Course Adopting the API First Principle Exploring APIs with curl Summary Quiz: Adopting and Exploring APIs Challenge: API Calls with curl Solution: API Calls with curl

Understanding HTTP, REST, and APIs

Understanding Web API Protocols, Practices, and Styles The Web and the REST API Managing Files with Git Creating a Public GitHub Project Summary Quiz: HTTP, REST, and APIs Challenge: Understanding HTTP, REST, and APIs Solution: Understanding HTTP, REST, and APIs

Modeling APIs

Understanding the Norman’s Action Cycle Modeling Our Onboarding API Cycle Writing an API Story Creating Our npm Package Managing Our Project with npm Summary Quiz: Modeling APIs Challenge: Modeling APIs Solution: Modeling APIs

Designing APIs

The Power of Design

The API Design Method

Identifying API Descriptors

Creating Our Sequence Diagrams for an API Design

Quiz: Designing APIs

Challenge: Designing APIs

Solution: Designing APIs

Describing APIs

Learning the Role of Description Formats

Describing our API with ALPS

Updating an API Project

Quiz: Describing APIs

Challenge: Describing APIs

Solution: Describing APIs

Sketching APIs

Learning from Frank Gehry’s Sketches API Sketching Example The Advantages of Sketching Sketching APIs with the Apiary Editor API Sketching Tips and Tricks Summary Quiz: Sketching APIs Challenge: Sketching APIs Solution: Sketching APIs

Prototyping APIs

What is an API Prototype?API Prototyping with OpenAPI Translating API Design into HTTP Introduction to SwaggerHub Creating Our OpenAPI Document with SwaggerHub Saving and Exporting an OAS Document Mocking an API Using SwaggerHub Generating API Documentation Summary Quiz: Prototyping APIs Challenge: Prototyping APIs Solution: Prototyping APIs

Building APIs

The API Reusable Build Process Coding APIs with Node.js and DARRT DARRT Project: Data DARRT Project: Actions DARRT Project: Resources DARRT Project: Representation DARRT Project: Transitions Putting It All Together Summary Quiz: Building APIs Challenge: Building APIs Solution: Building APIs

Project

Build a Rest API for an Image-Sharing App With Node.js

Testing APIs

The Goals of API Testing Testing with SRTs Using Postman for API Testing Programming Postman Tests Writing a Sad-Path Test in Postman Creating Postman Test Libraries Running Tests Locally with Newman Summary Quiz: Testing APIs Challenge: Testing APIs Solution: Testing APIs

Securing APIs

Basics of API Security Implementing API Security with Auth0 Supporting machine-to-machine security Summary Quiz: Securing APIs Challenge: Securing APIs Solution: Securing APIs

Deploying APIs

The Basics of Deployment Pipeline The Role of DevOps Deploying with Heroku - Setup on GitHub Deploying with Heroku - Production and App Launch Summary Quiz: Deploying APIs Challenge: Deploying APIs Solution: Deploying APIs

Project

Deploying a Web Application to Heroku Using CLI

Modifying APIs

Going Beyond Versioning The Three Rules for Safely Modifying APIs The Recommended Pattern for Testing for API Changes The Process for Safely Deploying APIs Shutting Down an Existing API Summary Quiz: Modifying APIs

Some Parting Thoughts

Summary What's next?

Appendixes

curl Installation GitHub and SSH Node.js and npm Postman and Newman Heroku Client Local Utilities

Design and Build Great Web APIs/

...

/

Summary

Summary

Review what we have covered in this chapter.

We'll cover the following...

This chapter reviewed a number of things related to documenting our API design in both machine-readable and human-readable formats. Along the way, we covered the importance of implementation-agnostic description formats for converting our diagrams into other formats, and the difference between general description formats and ...