Image for post
Image for post
https://www.akana.com/sites/akana/files/image/2019-06/image-blog-developing-api-strategy-600x400.jpg

About every single organization is promoting an API initiative, in that case, just having a great and functional API might be not enough to attract and engage potential consumers. Even the APIs with fabulous Swaggers, sometimes might lack detailed information and documentation for developers, being in how to use the API’s SDKs, or simply documentation more in-depth. In this post, we will show a great tool to help both in API Dev Portal, and why not, your whole Developer Experience — DevExp.

Image for post
Image for post
Engaging your Developers and API Consumers

Generating the APIs Documentation while Coding

Developers are intended to be no big fans to document their things. If you work with people like that, please buy them a coffee every day. For that reason, it is extremely important you get the docs and information about the APIs, while Developers are developing them. …


Image for post
Image for post
Source: https://undraw.co/

Recently we had the Brazil's Central Banking publishing the regulation about OpenBanking. By October 2021, the expected 4 adoption milestones/phases must be ready. Lot's of good things ahead! One of the greatest tools that we added as part of our implementation framework to solve some challenges on this is actually Go-Swagger. In this post, I will show how to expose an astonishing API DevPortals using that tool

Installing Go-Swagger

There are several installation options in the documentation here: https://goswagger.io/install.html . …


I am the kind of person that believes that everything happens for a reason, I’ve been trying to avoid follow the news from my country(Brazil), as we have kind of several opinion’s monopolists where everything is extremely bad and catastrophic, it is a matter of fact that the entire world will suffer impacts of this pandemic times we are living now, it is a kind of individual duty to decide how to react to that, in my case, I’ve been trying to be optimistic, investing my company’s cash to keep our employees and people with us.

Well, I got this time to work even harder and enjoyed every moment possible with my family, in special my kids: Valentina a girl almost 6, and Benicio an unstoppable boy(2). It is pretty spellbinding how the children look at the world, another day my wife asked Benicio what my brother in law works with, he answered "He works with vruuuuns" (he meant: He works with cars"), and then she asked: "And what about your daddy?" He answered: "Daddy talks to people". Maybe during this time, he noticed the communication magic, looking at me talking with many faces in side by side squares in a laptop screen. Anyway, he is 2, but I took a few minutes to show him how a computer works, his preferred game is the chrome off-line internet dinosaur that jumps the trees. For me it was a big surprise, in so digital and coloring world, he loved the simplicity of jumping trees, and when he fails, somehow he got a wish to try again. I explained to him when he was able to execute more and fewer steps, it is fascinating to see a 2 years old kid getting started to understand that things are progressive, that sometimes we fail, and sometimes we go further. Well, I try to do this now with him daily basis for not too long, but up to the point that he won his own level. …


Image for post

During every major crisis, humanity took valuable lessons to overcome the hard times and grasp opportunities to go to the next level in evolution. The current turmoil is giving us a lot of opportunities to learn, gain insight and a chance to adapt and grow. In this post, I will try to share some of the new challenges that we are working through with our customers in these unpredictable times.

Many Business will have a different pace

Image for post
Image for post
Source: https://cdn5.f-cdn.com/contestentries/1355127/28284820/5b36ba4981966_thumb900.jpg

While some industries are extremely impacted as social distancing, quarantine, and isolation are required, others can leverage the chance to emerge as winners and even new Unicorns. We probably all noticed that the delivery services industry (food, beverages, etc) have been growing incredibly fast, but there are also many other segments which will be positively impacted by the actual crisis. …


In companies’ API initiatives, we can see some tools that can make our lives much easier when implementing our projects. I took 3 of our set of tools to share with you in this post.

API designing: “API First Always"

One of the most important strategies in an API initiative is to be able to create your contracts first. These contracts can be defined in JSON or YAML format, and follow the standard market specifications called Swagger (version 2.0) or Open API Specification (version 3.0) respectively. If you are interested in reading more about API First strategies, please check this post.

1. StopLight: Create Swaggers/OAS specs much easier

Looks kind obvious, but one of our major issues in API projects and consulting engagements we have been found is exactly on the specifications of the contract (Swaggers), might be due to the lack of knowledge or experience. In that regard, StopLight can be an incredible option, once it allows you to design your APIs resources, models, documentation in a very effective manner. …


Image for post
Image for post

1. API First Concepts

APIs? What are they? That is the million dollar question nowadays. We could come up with thousands of answers, but we prefer this simple analogy.

A very easy analogy might be: Your APIs are to your business what a panel and controls are to a car. Most people have no clue about how a car works under the hood but knows that if you push the accelerator, the car goes faster, and if you apply your brakes, the car will eventually stop (Figure 1). Similarly, things like climate control, blind spot detection, and adaptive cruise control provide a safer and more enjoyable driving experience without you having to worry about how those systems do what they do. …


Create integrations that interact with the famous SaaS vendors in the market is crucial for any integration technology. For Ballerina-Lang it is extremely important, especially given the fact the the most of the organizations are living the hybrid IT, combining on-premises with cloud-based solutions.

Image for post
Image for post
Salesforce.com

This is a Service Example that shows you how you can do a basic searching in Salesforce:

Note: Create a dev account in SFDC is out of the scope of that post :)

Service that Invokes a basic Search in Salesforce

We created a Service called sfdc which contains a resource called querySalesForce.

As global access for any other resource, we had declared the following…


Ballerina language is a programming language focused for integration , which can make your life far easier. You might ask why? Well, one of the reasons is that in the last about two decades, we have been representing some of our integrating tasks using Sequence Diagrams, for transmitting and sharing our ideas, and then transferring our thoughts to some integration tool.

One of the good things in Ballerina, is that the diagram that you use to define your ideas, can now be used to execute them too. …


Upon a time, back in 2010, I made an interesting POC, when REST started to become a stronger "de facto" performer in the industry.

In that time of my life, I can say that I had more free time to invest in things that I liked, or even chance to create crazy POCs for demonstrating the potential from my employer from that time.

Well, in early 2010, I create a kind of a prototype of an Web App that could act a backend to facilitate people to create their "WebServices" (that time we did not mentioned APIs that much).

That was a prototype made with my brother (Jefferson), when I was helping him in one of his efforts to create some cool stuff on Google App Engine on that time. …


Heroku is one of the most popular Cloud PaaS providers in the market, and for that reason I decided to show how you can write microservices/applications using WSO2 Microservices Framework for Java — msf4j, and host them there.

Image for post
Image for post

First off all, I followed the tutorial focused for Java, available in the Heroku Dev Center (https://devcenter.heroku.com/articles/java-support), I recommend you take a look on this, once I will also follow the same recipe in this blog post.

Creating the Project with MSF4J Archetype

In this step, we will execute the Maven archetype:

mvn archetype:generate -DarchetypeGroupId=org.wso2.msf4j -DarchetypeArtifactId=msf4j-microservice -DarchetypeVersion=1.0.0 -DgroupId=io.edgar -DartifactId=ms4j-app -Dversion=1.0.0-SNAPSHOT -Dpackage=io.edgar.service

Image for post
Image for post
Execution with Successful

See the generated project:

Image for post
Image for post
Genereted Project

You had generated a project that is the skeleton for your future Microservices. …

About

Edgar A Silva

Just a dad, husband, and an Old-School Brazilian Jiu-Jitsu Black-belt. Skalena Founder, former WSO2, MuleSoft, Oracle, RedHat, Sun, Borland

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store