4 Key Guiding Principles to Building Your Application Network
Take a look at four important factors to keep in mind when building your API.
Join the DZone community and get the full member experience.Join For Free
in a previous post , i explained the reasons why pure soa , despite being a powerful architectural paradigm with many benefits, could fall short. building on that narrative, i will provide in this post guiding principles to help you create a modern integration strategy – one that enables digital transformation , supports the api economy, and is suitable for the pace of change required to build an application network .
today's challenges are very different from yesterday's. if you think integration is playing the same role as it did 20 years ago, none of the following guiding principles will make sense or seem relevant. yesterday's challenges were about connecting and integrating different back-end applications to ensure data was synchronized among them. today's challenge is all about connecting data to an ever growing audience. it is about unleashing assets that until now were sitting in the dark corners of your organization.
1. design first for reusability
in my previous blog post , i gave the comparison about a band playing on a stage. the problem with that band was that they did not bother to please the audience. crazily enough, that is how we create and expose most of our apis ! a design-first approach means we first design apis and then, only after we've agreed on an initial design, we build them. this order should be the norm. this might seem surprising, but there are an enormous number of apis that are created not using this principle. when those apis are created in the wrong order (not design-first), the consumers usually don't understand them. because they don't understand them, they don't use the apis. for those who worked with wsdl and the contract-first approach, it is similar, but please bear in mind that we are talking about something much more profound and broader than just technology.
design-first is also about talking to the audience. it is about making sure we understand their terminology, and speak with them in a language that they understand. this is important to prevent people building poor functionality based on terms, expressions, and vocabulary that are not clear between consumer and provider. for example, getting customer information is very different depending on the context of who needs customer data. this is also an on-going and interactive process. it has its own lifecycle doing modeling, validation, and simulation in a continuous feedback loop. that is what we call the design lifecycle.
when the design lifecycle is good enough, we go "backward" and find a way to connect, implement, and deploy the api. in this approach, we must heavily rely on an api design mechanism. in this sense, there is no better option than raml to fulfill this need. although there are many options available out there to document apis, most of those languages address general documentation, not design, as the main objective. at mulesoft we truly believe that api design is a very important aspect of the total api lifecycle . anypoint platform provides a seamless experience for api designers to use raml (extra swagger support coming soon!) and make it a true blueprint for api implementation.
2. make it self-service
you might argue that going to an à la carte restaurant is charming and personal, but when you are talking about serving food at scale, nothing beats the concept of a self-service restaurant. it has been designed to allow consumers to get food with little interaction or support from the providers. you can feed more people much faster. as a food provider, you just have to make sure you have quality ingredients and have the infrastructure and facilities to serve people properly. it is a very scalable model.
this is the concept that we should apply to integration. when developers want to access certain systems, it should be easy for them to do it. there is no reason we should force developers to talk to systems owners to understand how a particular integration works. imagine a 21-year-old developer fresh from university who is forced to understand the data model of a legacy erp system using an exotic protocol. it is hard. she will need help from the erp guru to explain what that data model actually means. we can help this young developer and make her job easier and more fun. when we create truly simple and productized rest apis on the top of the erp, it brings big relief to both parties. developers can move faster, and providers don't need to stop their daily operations to enable someone else. that is a much more scalable model.
3. make your enterprise composable by promoting consumption via apis
often people think that apis are more relevant to external consumers. the reality is very different. the hidden potential of apis lies in internal consumption by lobs, departments, and sub-organizations. there is nothing wrong with external consumption, but a big majority of your api thinking should be to drive internal consumption of apis.
historically, internal connectivity has been either absent or has been done suboptimally. when apis came up on the agenda, many people rapidly understood their benefits and started to apply them to external consumption. it is the first intuitive step to take — you want to look good from the outside. however, we can do much more with apis. what about applying all this goodness to internal connectivity challenges? it is a perfect fit and the problems you are solving are very similar.
when you think about apis this way, you can start to see your application network emerge. we build the application network with an approach called api-led connectivity . remember that api-led is about connecting assets to the audience and it handles the full lifecycle of their apis. take a look at more resources if you are interested in this approach.
there are three important aspects:
- we have different api types. we call them system apis, process apis, and experience apis. each api type carries different attributes (deployment model, sdlc, etc).
- all those apis are designed, built, and governed from one single platform — anypoint platform.
- internal connectivity challenges aren't just solved by technology — it's a cultural and mindset shift. elements that are usually ignored in this regard are the people and the organization aspects. that is where accessibility and ownership comes in and a where a federated organization is used for the enablement and the creation of self-service assets. this is the operational model and it is called c4e . its main outcome is about shifting the role, and culture, of central it from project delivery to a more agile enabler for the business.
4. unlock assets with security and governance
the ability to easily provide access to data is both exciting and scary. obviously, providing access to central enterprise data is critical to speed up business initiatives, but at the same time, not everybody should have access to all data. it is a bit of a paradox.
from a design perspective, developers want and should have access to data and functionality exposed via apis. from a security and governance perspective, only certain groups can get permission to edit and manage that data.
this paradox is solved with the usage of runtime policies to decouple functional and nonfunctional requirements.
functional requirements will describe what a particular api does. it is totally defined and created by the api developer and api owner. non-functional requirements, for example, are security patterns that should be enforced when accessing that particular api. they should not be mixed. for example: you can have an api on a test environment with no policy enforced, but when this api is promoted to the production environment, an authorization via ldap policy is required to access it.
this allows developers to create and easily build functionality on the top of existing functionality in dev and test environments. whenever apis are deployed to production, they should enforce the appropriate security pattern via policies. the diagram below shows some of the available policies.
businesses today know that the path to succeeding in a competitive market means deploying technological solutions both efficiently and effectively, which means allowing the business to self-serve technology and allowing central it to manage it without blocking its development and deployment. an application network makes this feasible at scale.
Published at DZone with permission of Matheus Hermsdorff. See the original article here.
Opinions expressed by DZone contributors are their own.