Design and Build Great Web APIs by Mike Amundsen -- Read -- Imperial Library of Trantor

Index

Design and Build Great Web APIs

About the Pragmatic Bookshelf Table of Contents 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: Early praise for Design and Build Gr eat Web APIs Acknowledgments Preface

Your API Journey Who Should Read This Book How This Book Is Organized What’s Covered (And What’s Not) About the BigCo, Inc., Sample Project Online Resources

Part 1: Getting Started

Chapter 1: Getting Started with API First

Adopting the API-First Principle Exploring APIs with curl What’s Next? Chapter Exercise

Chapter 2: Understanding HTTP, REST, and APIs

Understanding Web API Protocols, Practices, and Styles Managing Files with Git What’s Next? Chapter Exercise

Part 2: The Design Phase

Chapter 3: Modeling APIs

Understanding Norman’s Action Lifecycle Modeling Our Onboarding API Lifecycle Managing Your Project with npm What’s Next? Chapter Exercise

Chapter 4: Designing APIs

The Power of Design The API Design Method Identifying Your API Descriptors Creating Your Sequence Diagram What’s Next? Chapter Exercise

Chapter 5: Describing APIs

Learning the Role of Description Formats Describing Your API with ALPS Updating Your API Project What’s Next? Chapter Exercise

Part 3: The Build Phase

Chapter 6: Sketching APIs

Learning from Frank Gehry’s Sketche s API Sketching Example The Advantages of Sketching Sketching APIs with Apiary Bluepri nt API Sketching Tips and Tricks What’s Next? Chapter Exercise

Chapter 7: Prototyping APIs

What Is an API Prototype? API Prototyping with OpenAPI Translating Your API Design i nto HTTP Creating Your OpenAPI Docume nt with SwaggerHub Saving and Exporting Your API Mocking Your API Generating Your API Docum entation What’s Next? Chapter Exercise

Chapter 8: Building APIs

Defining the API Build Process Relying on a Repeatable Process Coding APIs with NodeJS and DARRT Putting It All Together What’s Next? Chapter Exercise

Part 4: The Release Phase

Chapter 9: Testing APIs

The Goals of API Testing Testing with SRTs Using Postman for API Testing Running Tests Locally with Newman What’s Next? Chapter Exercise

Chapter 10: Securing APIs

Understanding Security Basics Implementing API Security with Auth0 Supporting Machine-to-Machine Security What’s Next Chapter Exercise

Chapter 11: Deploying APIs

The Basics of Deployment Pipelines The Role of DevOps Deploying with Heroku What’s Next? Chapter Exercise

Chapter 12: Modifying APIs

Going Beyond Versioning The Three Rules for Safely Mo difying APIs The Recommended Pattern for Testing for API C hanges The Process for Safely Deploying A PIs Shutting Down an Existing API What’s Next?

Chapter 13: Some Parting Thoughts

Getting Started The Design Phase The Build Phase The Release Phase What’s Next?

Part 5: Appendixes

Appendix 1: Installation Hints

curl Git GitHub and SSH NodeJS and npm Postman Newman Heroku Client Installing the Local Utiltities

Appendix 2: Exercise Solutions

Where’s the Code? 1: tarted with API First 2: HTTP, REST, and APIs 3: APIs 4: g APIs 5: ing APIs 6: g APIs 7: yping APIs 8: APIs 9: Is 10: APIs 11: ng APIs

Appendix 3: API Project Assets Checklist

Using the API Project Assets Checklist Notes on the Assets Checklist Your API Project Assets Checklist