Other Titles: Irresistible application program interfaces

Machine generated contents note: pt. 1 Understanding web APIs 1.What makes an API irresistible? 1.1.Integrating social APIs into web content 1.2.What is a web API? Do you need an API? Choosing REST APIs Json 1.3.Developer experience Versioning Marketing to developers 1.4.Common pitfalls of organic APIs Lack of vision Prioritizing the developer experience Bad API design 1.5.API creation process Determine your business value Choose your metrics Define your use cases Design your API Industry standards Design-drive development Support your developers 1.6.Summary 2.Working with web APIs 2.1.HTTP basics HTTP request HTTP response HTTP interactions 2.2.The Toppings API 2.3.Designing the API 2.4.Using a web API Browser Command line (curl) HTTP sniffers 2.5.Interaction between the API and client 2.6.Install your own API and front end Installing the system via Docker Contents note continued: Installing the system via Git Exploring the code 2.7.Summary 3.API First 3.1.Why choose API First? APIs as side products API First model 3.2.Code consistency 3.3.Functional equality 3.4.Increased productivity 3.5.Internal/​external access 3.6.Case studies API as the main product Mobile First Refactoring for API First API First strategic direction 3.7.Summary 4.Web services explained 4.1.HTTP fundamentals Addressability Status codes Body HTTP verbs Headers Parameters HTTP overview summary 4.2.REST web services explained 4.3.Exploring your API by inspecting HTTP traffic Setting up Chrome for HTTP inspection 4.4.Web services best practices Using the right status codes Methods and idempotency Nouns vs. verbs 4.5.Troubleshooting web API interactions Tools for API inspection Error handling Defensive coding 4.6.Summary pt. 2 Designing web APIs Contents note continued: 5.Guiding principles for API design 5.1.Don't surprise your users Flickr API example Don't make me think 5.2.Focus on use cases Use case: mobile Use case: application integration 5.3.Copy successful APIs 5.4.REST is not always best Expand and include related resources Create a query language Create a comprehensive data transfer scheme Create a separate batching system RESTful decisions 5.5.Focus on the developer experience Communication and consistency are critical Documentation should tell a story 5.6.Summary 6.Defining the value for your API 6.1.Business goals Monetization Usage Partner retention Market dominance 6.2.Metrics Poor metrics 6.3.Use cases Mobile Customer/​partner retention 6.4.Summary 7.Creating your schema model 7.1.What is a schema model? Contents note continued: 7.2.What does the API need to do? Top-level resources API resource methods 7.3.RAML Getting started Step 1 Adding Resources Step 2 Adding the methods Step 3 Query Parameters Step 4 Adding mock data Step 5 Adding mock data -GET Step 6 Adding mock data -POST Step 7 GET response format Step 8 PUT response format Step 9 Delete Step 10 Searching Support tools for RAML 7.4.OpenAPI (previously Swagger) Information about your API Step 1 API top-level resource methods: GET Step 2 API top-level resource methods Step 3 API subresource methods -GET, PUT, DELETE OpenAPI tools and resources 7.5.Summary 8.Design-driven development 8.1.Development strategies for your API Waterfall development Agile/​test-first development Behavior-driven development Design-driven development Code-first development Why does project management matter? 8.2.Project management for APIs Contents note continued: Functional specification Schema model 8.3.Road-testing your API Creating a mock server API Acceptance tests and use cases 8.4.Planning development 8.5.Development sprints 8.6.Summary 9.Empowering your developers 9.1.Pillars of developer experience 9.2.Communicating with your developers Failures of communication Strong communication Advantages to strong and consistent communication 9.3.Documenting your API Reference documentation Workflows Tutorials 9.4.Building blocks Sample code Reference applications Tools and techniques 9.5.Developer support Interactive Noninteractive 9.6.Summary.

"Irresistible APIs presents a process to create APIs that succeed for all members of the team. In it, you’ll learn how to capture an application’s core business value and extend it with an API that will delight the developers who use it. Thinking about APIs from the business point of view, while also considering the end-user experience, encourages you to explore both sides of the design process and learn some successful biz-to-dev communication patterns. Along the way, you’ll start to view your APIs as part of your product’s core value instead of just an add-on"--Back cover.