How to navigate the current software developer market
Import from medium.com
October 09, 2021
The big skills crunch is coming and we need to rethink how we approach talent acquisition. According to a Mckinsey report from last year…Continue reading on Python Geek »
See publication
Tags: Cloud, Digital Transformation, DevOps
You’re developing your API clients the wrong way
Import from medium.com
March 27, 2021
What’s wrong with popular approaches to developing API clients, and what can you do to improve the development experience.Continue reading on Python Geek »
See publication
Tags: Cloud, DevOps, Digital Transformation
Documentation-driven development for APIs: what is it, how do you do it and why you should do it?
Import from medium.com
October 19, 2020
The code for this post is available under: https://github.com/abunuwas/documentation-driven-developmentContinue reading on Python Geek »
See publication
Tags: Cloud, DevOps, Digital Transformation
Leveraging API documentation to deliver reliable API integrations
OpenAPI Initiative
October 08, 2021
API integrations are at the core of everything we do online. They enable integrations between different services, and they power the servers that bring our applications to life. The pervasiveness of APIs has led to the emergence of the so-called API economy, and most digital products are nowadays built around APIs, both for internal and for public consumption.
The sustainability of our APIs relies on our ability to deliver successful API integrations. However, more often than not, API integrations tend to fail. This is due to a variety of factors, such as lack of API documentation or bad API documentation, lack of API design, and the use of ineffective workflows for API development.
Lack of documentation, or bad documentation, prevents API client developers from building effective integrations with the backend, while lack of design makes APIs difficult to understand and therefore difficult to integrate with.
In this presentation, I want to present API development workflows that I’ve successfully used with my clients over the past years to deliver successful API integrations. I’ll present strategies for consolidating the API documentation, and I’ll show how we use documentation-driven development to leverage API documentation and deliver successful API integrations. Through this approach, we can use mock servers and robust API testing frameworks for testing and validating our implementations.
See publication
Tags: Cloud, Cybersecurity, DevOps
Documentation-driven development for Python web APIs
EuroPython
September 27, 2021
This presentation shows how we can use documentation-driven development to minimise the risk of API integration failures. APIs are the gateways that connect our web applications to the world. Microservices rely on them to work together, and frontend applications use them to connect to our backend. Despite their importance, API integration failures are a daily occurrence. There’re many reasons for this, but a common factor is the lack of API documentation, or the use of bad API documentation.
Often, API documentation comes in unstructured formats or in JSON examples, instead of standard formats such as OpenAPI or Schema Definition Language. When we don’t use standards to document our APIs, we give up the whole ecosystem of frameworks and tools built around those standards. Such tools and frameworks are designed to make our lives easier when managing the lifecycle of our APIs.
In documentation-driven development, we write the API specification first, and then we implement the API server and the client against the specification. I’ll show how we can use mock servers to test the client while the backend is being developed, and tools like Dredd and schemathesis to validate the backend implementation. I’ll show how we can use these tools in a CI server to validate our code before it’s released. This approach doesn’t eliminate completely the risk of API integration failures, but it helps to minimise it.
See publication
Tags: Cloud, Cybersecurity, DevOps
API Development Workflows for Successful Integrations
Manning
September 02, 2021
APIs are the fundamental tenets of the Internet. They enable integrations between different services, and they power the servers that bring our applications to life. API integrations lay at the core of our API-driven world, and delivering successful API integrations is fundamental to sustain it. However, more often than not, API integrations tend to fail due to ineffective development workflows. In this presentation, I want to present various API development workflows that have helped me and my clients deliver successful API integrations. I’ll show how documentation-driven development, using mock servers, robust API testing frameworks, and API visibility tools can help to significantly reduce the chances of API integration failure and to keep errors under control.
See publication
Tags: Cloud, Cybersecurity, DevOps
Delivering successful API integrations
Conf42
June 26, 2021
Modern web applications are usually served over APIs. Through API integrations, we enable communication between microservices and between backend and frontend. Successful API integrations are crucial for the stability of our platforms and the products and services we build around them. However, more often than not, API integrations tend to fail. Reasons vary, but a common factor is lack of proper API documentation. In this presentation, I want to show how we can use documentation-driven development to deliver successful API integrations, by leveraging the big ecosystem of tools and frameworks developed around API specifications.
In documentation-driven development, we write the API specification first using a standard specification format. I’ll show how we can leverage documentation to test and validate our API implementations before we release them, and how we can develop our clients using API mock servers. The approach described in this presentation won’t eliminate completely the risk of API integration failures, but it’ll surely lead to a more robust software delivery process for our APIs.
See publication
Tags: Cloud, Cybersecurity, DevOps
Documentation-driven development for web APIs
API Conference
April 12, 2021
API integrations can be a pain. Anyone who has worked on API integrations has probably observed that, as a general rule, no API server survives first contact with the client. Reasons vary, from badly written API documentation to complete lack of API documentation. In this presentation, I want to address this problem by showing how developers can minimise the risk of API integration failures by using an approach called documentation-driven development. In documentation-driven development, we write the API specification first using a standard specification format. I’ll show how we can leverage documentation to test and validate our API implementations before we release them. I’ll show how we can use tools from the current ecosystem, such as Dredd, to automatically generate tests that validate our APIs. The approach described in this presentation won’t eliminate completely the risk of API integration failures, but it’ll surely lead to a more robust software delivery process for our APIs.
See publication
Tags: Cloud, Cybersecurity, DevOps
Documentation driven development for Python web APIs
Python Barcelona
December 16, 2020
In this presentation, I want to show how developers can minimise the risk of API integration failures by using documentation-driven development. Documentation-driven development is an approach where we first write the API documentation, and then we validate the API implementation against the specification. This approach helps us create a more robust software delivery process for our APIs. I’ll show useful tools and frameworks, such as Dredd, that can help us automatically generate tests that validate our APIs.
See publication
Tags: Cloud, DevOps
Microservice APIs in Python
