|This week we have tips for API design from the API Handyman, writing a great README, and a discussion on consumer-driven contracts. Happy reading! -- James
API Design Tips And Tricks - What if consumers can't do PATCH, PUT or DELETE?
There are quite many APIs out there taking advantage of all standard HTTP methods (GET, POST, PATCH, PUT and DELETE). Unfortunately, there are still some cases where consumers can't use them all. As far as I know, GET and POST do not cause any problem at all. by Arnaud Lauret [apihandyman.io]
How to write a kickass README
Arguably the single most important piece of documentation for any open source project is the README. A good README not only informs people what the project does and who it is for but also how they use and contribute to it. by James.Scott [dev.to]
Split the deployment of your frontend and backend with CDCs
Consumer driven contract testing is a great way to improve the reliability of interconnected systems. Integration testing becomes way easier and more self contained. It opens the door for independent deployments, and leads to faster iterations and more granular feedback. Unlike your insurance, it doesn't have any fine print. [freecodecamp.org]
Hello REST API: What can I do next?
In this presentation, Kai shows how to use hypermedia to create REST APIs that do not only provide data but also information about what to do next. This can be in the form of hyperlinks for navigating and describing actions that can be performed on the REST resources. by Kai Toedter [speakerdeck.com]
OData or GraphQL? The Best Tech for Developing an API Is Neither or Both!
Tribes throughout history have led to some of the most nonsensical decisions in human history. From the bloodiest days of the French Revolution to the current UK Brexit impasse. As a man from the North of England of working-class descent, and working in the liberal hotbed of West London for an American software company, I... by Kris Patefield, Amir Souchami, Claire Cadman [thenewstack.io]
Is OpenAPI the Gateway to DevOps Success?
It's not an understatement to say that OAS (OpenAPI Specification) has changed the way many developers design their APIs, with its standardized format allowing for easier adoption and implementation of APIs. by Art Anthony [nordicapis.com]
What airports can teach us about API security
Frequent travel through airports across the United States has influenced my views on security best practices for application programming interfaces. U.S. airport security has evolved into a federated model of collaboration between state authorities, airlines and the Transportation Security Administration incorporating terminal concourse design constraints, a multiplicity of access control mechanisms and constant monitoring. [gcn.com]
The Business of APIs
API Product Ideation and Validation
Ultimate Step-by-Step Guide to Ideate and Validate API Product Ideas Based on Customer Journey You are familiar with APIs. You know the data and service assets that are at your disposal and you know the stakeholders. But you never had the opportunity to think about new API products because you focused on API delivery. by Amancio Bouza [medium.com]
APImetrics Annouces New Monitoring Product for Postman APIs
APImetrics has launched a new monitoring service for Postman users, the company announced yesterday. "We are very excited to launch this product, which will allow users of Postman to monitor global API performance without having to do any configuration at all," said David O'Neill, CEO of APImetrics. [heraldstandard.com]
DevOps is changing, and some are challenging "shift left" management
TechRepublic's Karen Roby interviews Checkmarx's Matt Rose about the possibility that "shift left" is no longer the gold standard in DevOps, and that agile is more than just a verb. TechRepublic's Karen Roby discussed "shift left" with Matt Rose of Checkmarx. The following is an edited transcript of their interview. by Karen Roby [techrepublic.com]
Scaling in the presence of errors-don't ignore them
Building a reliable, robust service often means building something that can keep working when some parts fail. A website where not every feature is available is often better than a website that's entirely offline. Doing this in a meaningful way is not obvious. [programmingisterrible.com]
"How NOT to Measure Latency" by Gil Tene
Time is Money. Understanding application responsiveness and latency is critical but good characterization of bad data is useless. Gil Tene discusses some common pitfalls encountered in measuring latency and response time behavior. He introduces how simple, open sourced tools can be used to improve and gain higher confidence in both latency measurement and reporting. by Strange Loop [youtube.com]
Running and diagnosing Kubernetes: A Twitter thread by @jessenoller
"Here my quick and dirty Kubernetes issue diagnosis a thread: 1. Random latency talking over network A: check disk IOou're probably exceeding the IO levels on the OS disks. I bet it's disk 2. My cluster goes down during an upg [...]" [threadreaderapp.com]
Decentralized Identifiers (DIDs) v1.0
Decentralized identifiers (DIDs) are a new type of identifier for verifiable, decentralized digital identity. These new identifiers are designed to enable the controller of a DID to prove control over it and to be implemented independently of any centralized registry, identity provider, or certificate authority. [w3.org]
Serverless computing ... with Pascal!
Upcoming Web API Events
A list of upcoming Web API Events, maintained by Matthew Reinbold
Tyk Whitepaper: Approaching your API Strategy
As well as writing for the James Higginbotham is an Executive API Consultant with experience in API strategy and software architecture. James guides enterprises through their digital transformation journey to deliver a great customer experience and provides training in API and microservice design. [content.tyk.io]
Book: A Practical Approach to API Design by Casey and Higginbotham
If you read the tech press, everyone knows they need an API but most aren't really sure what it is. They treat it as another checkbox like "Web 2.0" was a few years ago or a mobile app was most recently. In fact, there’s an entire “API-first” movement in development circles that most people don’t understand or even realize why. In this book, we'll start by discussing the what an API is, why you might need one, and follow up with the how to build one. [leanpub.com]
Want to share something?