apidays LIVE JAKARTA - 359o of API Design: Things to consider when crafting your API Specification by Ariyandi Widarto

Nov 4, 20200 likes1,381 views

apidays LIVE JAKARTA - Connecting the Digital Stack 359o of API Design: Things to consider when crafting your API Specification Ariyandi Widarto, Software Engineer at DANA

359o
of API Design
Things to Consider when Crafting API Speciﬁcation
Ariyandi Widarto
September 2020

API to Connect the Digital Stack
Engineer
Business
Product
Finance
HR
Analogy

API to Connect the Digital Stack
En
Bu
Pr
Fin
H
En
Bu
Pr
Fin
H
En
Bu
Pr
Fin
H
Analogy

API to Connect the Digital Stack
Analogy

API to Connect the Digital Stack
Analogy
APIAPI
API
API
API
API

Hold on a bit, before that,
what is the impact if we
don’t do proper API design?

- Business Requirement
- Idempotent & concurrency
- Standards
- Documentation
- Backward compatibility
- Extensibility in the future
- Testing
- Monitoring & tuning - Security standards

Business Requirement
Use cases Business rules

Compatibility & Extensibility
100% backward compatible
API migration
Easy to extend and scale

Security
Image by en.wikipedia.org
Image by business2community.com
HTTPS, IP whitelist, ﬁrewall, sensitive data encryption, PCIDSS, ISO standards, etc…….
Image by docs.oracle.com

• Naming convention

• Path convention

• HTTP method convention

• Header & body format

• API timeout

• Logging convention

• Eﬀective and structured documentation
Standards & Documentation

Testing
• Complete and well documented UAT

• Positive cases

• Negative cases

• Idempotent cases

• Concurrency cases

• Performance testing

• Load testing

• A/B testing

Monitoring & Tuning
TPS target Monitoring dashboard
Limiter & switch Technical improvement

–Prometheus
“Big things have small beginnings.”

apidays LIVE JAKARTA - 359o of API Design: Things to consider when crafting your API Specification by Ariyandi Widarto

Thank you!
I’m very interested if you have some other perspective, feel
free to send me an email to discuss (ariyandi.widarto@dana.id).

This document discusses strategies for transforming an enterprise with APIs. It presents two API strategy styles: business unit centric and enterprise wide. The business unit centric style allows autonomy but can lead to inconsistency across units. The enterprise wide style promotes harmony but requires units to comply. The document also describes a do-it-yourself model for APIs, with pillars including immersion, governance, tooling, and developer portals. It argues that combining an enterprise wide strategy with the do-it-yourself model can help organizations realize the benefits of APIs while maintaining business agility.

apidays LIVE Australia 2020 - API Design in Fintech: Challenges and Opportuni...apidays

Lean and Business oriented method at APIOps Cycles APIDays Finland 2019 Marjukka Niinioja

Marjukka Niinioja presents the APIOps Cycles method for building APIs using lean principles. The method focuses on collaborating with customers, adopting a DevOps mindset, and considering business needs and developer experience. Key aspects of the method include prototyping APIs, conducting API audits, and connecting APIs to business goals using canvases. The goal is to minimize waste and build the right APIs for customers through an iterative process.

apidays LIVE Paris - The State of SaaS Integration by Gertjan De Wildeapidays

The document discusses trends in SaaS integration and API standardization. It notes that the number of SaaS apps used by companies is growing significantly each year, driving demand for easier integration. API standards like OpenAPI are gaining adoption and helping improve integration. It recommends companies adopt a hybrid integration strategy using both native and third-party integrations. Focusing on the developer experience through SDKs, documentation, and events can help attract more developers to an API. The document predicts continued growth in areas like no-code/low-code platforms, embedded workflows, and compliance-focused APIs.

O'Reilly author webinar "APIs: A Strategy guide": Transforming Your Business...Apigee | Google Cloud

apidays LIVE JAKARTA - APIs as Products in payments, telecommunications and D...apidays

APIdays Zurich 2019 - Boosting the Digital Transformation at UBS with APIs Ro...apidays

UBS is undergoing a digital transformation to support 24/7 availability and new client interactions, requiring changes to its IT platform and architecture. It is transitioning to an API-first approach and modular systems to increase agility. This involves adjusting its delivery model to be more collaborative, user-centered and cross-functional. UBS is establishing a Digital Factory to drive innovation, accelerate time-to-market, and attract talent through strong collaboration. The Digital Factory breaks down barriers between teams and treats APIs like contracts between consumers and providers for stability. Automated testing allows for shorter release cycles and cost effectiveness. The digital transformation is an ongoing journey of continuous evolution.

Api architectures for the modern enterpriseCA API Management

Extend your legacy SOA/ESB infrastructure to Mobile & IoT This webinar recording provides a use-case driven discussion around appropriate use of existing middleware infrastructure as well as its shortcomings. It dives deep into how APIs can not only complement an ESB or SOA infrastructure but also fill existing gaps. Watch this webinar recording to learn about: - Strengths and weaknesses of your existing ESB/SOA infrastructure - Architecture strategy: extend and add value to legacy middleware with APIs - Integration / API use cases in Retail, Manufacturing and Telecom - The API360 approach to digital strategy

apidays LIVE Paris - Marketplace API modernization: how to scale your busines...apidays

APIdays 2019 - The API mindset for IT and Business Tom Cully, BlackRavenapidays

The document discusses the "API mindset" and how it transformed Amazon. It summarizes Jeff Bezos' 2002 memo mandating that all Amazon teams communicate through APIs instead of direct links. This forced externalization led to Amazon Web Services and its massive cloud business. The API mindset is about enabling others rather than direct sales. It discusses how to implement the API mindset by consuming your own APIs, offering capabilities instead of products, and being willing to give things away for free like open source. The API mindset can transform products, businesses, and the world by better serving others.

The Architecture of an API PlatformJohannes Ridderstedt

apidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guoapidays

apidays LIVE JAKARTA - How we Build APIs and Workflows at Slack by Bear Douglasapidays

The API Economy: Adding Business ValueSmartBear

apidays LIVE LONDON - Protecting financial-grade APIs - Getting the right API...apidays

INTERFACE, by apidays - From Monolith to Open Finance with APIs by Marcilio ...apidays

APIdays Zurich 2019 - IT and Business as Critical API Partners, Strategies to...apidays

apidays LIVE Helsinki & North - Bye bye to the insurance monolith - case Eule...apidays

This document discusses an insurance company's transition from a monolithic IT architecture to a microservices architecture using APIs. Some of the key challenges in the transition include ensuring consistent API design, implementing cloud infrastructure securely, complying with regulations, maintaining quality and resilience across many independent services, and aligning planning between multiple API-based products and teams. The goals of the transition are to enable greater agility, simplify global collaboration, and move away from the limitations of the monolithic "culture."

apidays LIVE Australia 2021 - Planning Your Steps to Data Economy Using APIOp...apidays

APIdays Zurich 2019 - Reactive & Distributed - Modern application architectur...apidays

The document discusses the evolution of application architectures from monolithic to microservices and reactive distributed systems. It covers topics like microservices, event-driven architectures, CQRS, event sourcing, and serverless/functions-based computing. The key stages of evolution involve moving from monolithic applications to modularized services, introducing distributed systems concepts like service discovery, moving to reactive programming models using handlers and event buses, and serverless/functions-based models.

Business Challenges Solved by APIs: What Every Executive Should KnowElastic Path

It seems like everyone either has or needs an API these days. Analysts are touting how critical it is for businesses to engage their customers across every touchpoint. APIs are supposed to fuel innovation for these new applications, new channels, and, ultimately, new ways to generate revenue. But getting your API strategy off the ground could be more difficult than it sounds. Even with the right strategy and architecture, there are very real technical challenges in your way. Join API experts from Elastic Path Software as well as API Evangelist Kin Lane for a frank discussion on the current state of APIs.

apidays LIVE Paris - Driving innovation through External APIs without putting...apidays

External APIs are driving unprecedented innovation across industries like e-commerce and fintech by automating processes, improving customer experiences, and enabling new business models. However, using third-party APIs also carries risks around security, compliance, and business continuity if not properly governed. The concept of "shadow APIs" - APIs used without an organization's knowledge - exacerbates these risks. To mitigate risks, organizations should detect all API dependencies, build an API knowledge base, integrate governance into development processes, and map all API data flows. Proper API governance is crucial, especially for external APIs over which organizations have less control.

apidays LIVE JAKARTA - Enterprise API management in agile integration by Ragh...apidays

The document discusses enabling API management using a GitOps framework. It describes key components needed for API management like the OpenAPI spec, implementation code, infrastructure code, integration configuration, API management configuration, API gateway configuration, and API catalog. Using GitOps provides benefits like empowering developers to manage infrastructure configuration similarly to code using Git, keeping configurations declarative and version controlled, and enabling simple, automated, auditable deployments that detect deviations from the configuration.

APIdays Singapore 2019 - SDKs and Code Samples - The Cornerstone of API Devel...apidays

The document discusses how SDKs and code samples are cornerstones of API developer experience. It notes that decades ago, developers had to work with machine code directly, but now have access to higher-level languages, SDKs and code samples to more easily access and build on APIs. The document advocates that API providers should focus on automating the creation of dynamic code samples and SDKs to remove redundant work for developers and provide a premium developer experience.

apidays Australia 2023 - API Strategy In The Era Of Generative AI,Shreshta Sh...apidays

apidays Australia 2023 - Platforms, Products, and People: The Power of APIs October 11 & 12, 2023 https://www.apidays.global/australia/ API Strategy In The Era Of Generative AI Shreshta Shyamsundar, Distinguished Technologist at Infosys ------ Check out our conferences at https://www.apidays.global/ Do you want to sponsor or talk at one of our conferences? https://apidays.typeform.com/to/ILJeAaV8 Learn more on APIscene, the global media made by the community for the community: https://www.apiscene.io Explore the API ecosystem with the API Landscape: https://apilandscape.apiscene.io/

Creating DatadipityClickslide

More Related Content

What's hot (20)