This is part seven of the API design best practices series. Read part one of the series. Looking Back Unfortunately, this series of API Best Practices has come to a close. Over the last several months we’ve taken a look at how to design a flexible, extensible, and usable API. These steps included: 1. Planning Your API – The […]
This is part five of the API design best practices series. Read part one: Plan Your API » Read part two: Spec Driven Development » Read part three: Nouns, CRUD, and more » Read part four: Hypermedia » Read part five:Respond Handling » Design is Important, But… Over the last several weeks we’ve looked at the design aspect […]
This is part five of the API design best practices series. Read part one: Plan Your API » Read part two: Spec Driven Development » Read part three: Nouns, CRUD, and more » Read part four: Hypermedia » Provide Helpful Responses Building a solid foundation to ensure the scalability and longevity of your API is crucial, but just as crucial […]
This is part four, sub-series 3, of the API design best practices series. Jump to sub-series 1 of the hypermedia sub-series. A Road Trip First off, let me apologize for the delay in this third part of the hypermedia sub-series. Christmas meant a warm trip back to Minnesota, a road trip through the Texas panhandle, and numerous snow […]
This is part four, sub-series 2, of the API design best practices series. Jump to sub-series 1 of the hypermedia sub-series. Read part one: Plan Your API » Read part two: Spec Driven Development » Read part three: Nouns, CRUD, and more » The Harsh Reality of the State of Hypermedia Specs Hypermedia sounds great in theory, but theory only goes […]
This is part four, sub-series 1, of the API design best practices series. Read part one: Plan Your API » Read part two: Spec Driven Development » Read part three: Nouns, CRUD, and more » What is Hypermedia One of the challenges to implementing and correctly using hypermedia in your REST API is first understanding what hypermedia is, and what […]
This is part three of the API design best practices series. Read part one: Plan Your API » Read part two: Spec Driven Development » Once you have an understanding of what your API needs to be able to do in order to meet your developer’s requirements, it’s important to ensure that it remains as flexible and extendable as […]
This is part two of the API design best practices series. Read part one: Plan Your API ». Define Your API in a Flexible, but Standard Spec I cannot stress the importance of spec driven development enough. One of the quickest ways to kill your API is to define the API in your code, instead […]
This is part one of the API design best practices series. Read the introduction to the series: New Series: API Best Practices » Understand WHY you are building an API Perhaps the foundation of the foundation, understanding why you are building an API is a crucial step towards understanding what data/ methods your API should make accessible […]
API governance ensures consistent API quality and security through design, development, and deployment. We often see API governance as an impediment to product delivery. But without proper governance, the APIs we build and use to create a composable enterprise become the weak link that leaves data exposed.