Posts Tagged: URI

10+ Best Practices for Naming API Endpoints

There are plenty of reasons to name API endpoints thoughtfully. Choosing sensible names for API endpoints can drastically smooth out the learning curve for new developers, helping them intuitively know what to look for and where to find it. With that in mind, we’re dedicating this article to more than ten of the most effective best practices and conventions for naming API endpoints. Read more

Using Hypermedia To Design Event-Driven UIs

Some of the most powerful tech is now built fully on an API backbone. Web APIs are great because they can deliver data and functionality over HTTP — or other protocols — meaning agnostic client platforms, easier evolvability, and more efficient designs. Read more

7 Items No API Documentation Can Live Without

Web APIs are highly variable things – they can be custom-built, designed around a single purpose, all-encompassing, and almost everything in between. Shifting requirements dictate what the interface is comprised of. Due to this, it’s hard to find commonalities between APIs and their user-facing portals. Read more

Introduction to API Versioning Best Practices

Change is inevitable and growth is a good thing. When your API has reached the point of expanding beyond it’s original intent and capacity, it’s time to consider the next version.

Whether that next iteration is a whole number version bump or just a feature expansion, it’s important to consider the pros and cons of how you let your developers know about it. Read more

Using JSON-LD To Establish Semantic Linked Data

The world-wide web is a powerful tool, and much of this power is driven from the relational intersections between web pages, the data these pages host, and their further relations to other web pages and data sets. In fact, it is this fundamental relationship that drives the conceptual model and approach of the world-wide web – without these relationships, there would be no Reddit, no BBC News, and certainly no Wikipedia. Read more