API SDK Development – Lessons Learned

•

0 likes•780 views

Building a solid API is a challenge but getting our APIs to be adopted by a larger audience, we quickly realized that having solid SDKs is the key element. At Rubrik we have been developing SDKs to supplement our APIs for over 3 years and during this process we have been making sure our SDKs provide a seamless experience for end-users to consume. When breaking API changes occur during the development of our product. The key takeaways of this session are: * How to strategize SDK development against an ever-changing API * Securely open-source your SDK development process

Technology

API SDK Development -
Lessons Learned
Jaap Brasser – Developer Advocate

▪ Rubrik APIs
▪ The Goal
▪ Challenges
▪ Lessons Learned
▪ Questions

▪ Backup & Restore
▪ Cloud Data Management
▪ Disaster Recovery
▪ Test-Dev scenarios
▪ CI/CD Integration

▪ APIs are relatively new here
– Legacy tools, executables
– Custom modules or integrations
– GUIs everywhere
▪ Lack of understanding of the API space

▪ Build from the ground up to be API-first
▪ Good!
▪ API endpoints classified as internal
▪ Not good!
▪ OpenAPI Spec
▪ Excellent!

Session
Management
No Direct
API Calls
Structured
Output
Different
Users

Ease of Updating
Build Tooling on SDK
Extend SDK based on tools

Team Enablement
Open Source Management
Bugs in APIs
New API versions

Security of SDK
Automate everything
Branching and Releases

Create coding
& contribution
standards
01
Enforce Unit
Tests
02
Enable the
contributiors
03
Integrations &
Tooling
improvements
04
Issues and
Contributions
Time!
05
Do not
automate
everything
06

It is really hard to chose the right technology to use to build your devportal. The various types of devportals support 3 authoring experiences: -CMS based authoring - tight coupling between the content model and a UI -docs as code - code repo, or file based CMS -API based authoring - command line/endpoint as the interface We will discuss how things can go wrong if you don’t cater to your different authors

Lessons Learned from Revamping Our Doc Site

Pronovix

{Re}designing a Developer Portal

Pronovix

Engineer Stunning (API) documentation

Pronovix

Blood, sweat, and creating an API handbook

Pronovix

This talk describes the development of ABN AMRO’s API handbook, the single-source of truth for the development and management of internal and external API products. Our company is moving towards an API-First culture and mentality. Streamlining the development process is key to enabling this. In the beginning, API development knowledge was not documented or centralized in one location. Accurate information was not available for developer teams and they were not aware of what exactly the process entailed. My colleague and I began by making agreements on how the overall process works, describing it in an intuitive way, and then by making it open and accessible company-wide. This involved setting up and hosting face-to-face meetings or MS Teams calls with specialists to find out what was required This talk describes our approach to gathering content from experts, defining and refining processes, obtaining feedback from readers, and redesigning the content in a more user-centric format.

Leaping Forward: Finding The Future of Your API Docs

Pronovix

Advancing Your API Strategy in an Infrastructure World

Pronovix

Let Writers Write: Automating the Boring Stuff for Our Docs Team

Pronovix

We got into technical writing to make complex things seem simple, not to be janitors. So why do we spend so much of our time on maintenance? We fix broken links, find missing images, remove sensitive information... and that's only if we know these problems exist! Worst of all, we manually create and update code samples. Broken code samples are useless at best, and downright maddening at worst. Developer experience is really important to Adyen, and we got sick of seeing code samples become inconsistent and inaccurate. In this talk, Patrick Hammond will explain how Adyen approached the problem of creating, updating, and testing code samples. He'll discuss the solution they created, and how it works for their team. He'll also delve into some other common bugbears that Adyen are automating away, much to the delight of their 8 technical writers.

My team faced several questions a year ago when we started our brand new documentation portal. - Are we going to set up a platform based on an existing solution? - Are we going to create our own platform? - Are we going to use existing internal tools like Confluence? To answer those questions we created our own process to guide our decision making: - First create a vision how your documentation should look like - Then test as many platforms as possible - Realize non are quite what you want - Realise you do not want to reinvent the wheel - Figure out how you can glue different solution together to get exactly what you want We ended up with a mix of existing technologies like Doxygen and Sphinx, glued together with custom python scripts. This allowed us to rely on proven technology and still have the flexibility to tweak the result to our requirements, getting the best of both worlds. The biggest benefit of our solution is that it uses Unit tests to ensure that the documentation and the API stay in sync and developers are forced to update documentation when they change the API. This was one of the biggest benefits we gained from our new documentation system compared to the previously used. In this talk I will go into detail how we created and implemented our process, how it worked out for us and why your team might want to follow a similar process. At the end of the talk you will have a better understanding of - How to do research and compare documentation platforms - How to perform an informed decision for their documentation needs - How not quite reinvent the wheel and get what you want.

Tools and techniques for APIs

Jason Harmon

Pure APIs: Development workflows for successful API integrations

José Haro Peralta

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.

Getting Started with ASP.NET vNext

Lohith Goudagere Nagaraj

API Conference 2021

José Haro Peralta

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 minimize 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.

GraphQL vs BFF: A critical perspective

Pronovix

Imagine an application that has a web and a mobile, IOS and Android, or that your API is consumed by similar frontends from totally different teams. The functionalities they provide are distinct, hence the need for distinct sets of data and functions. You might think that the solution for this is having an “as generic as possible” backend for all UI’s. From my experience, this kind of backend leads to big issues in matters of performance, entangled user experience as well as extra and unnecessary communication for the development teams in order to align and meet their needs. Fortunately, there is a promising set of approaches taking the stage as they are created with the intention to optimize how front-end applications collaborate with back-ends: BFF (Backend-For-Frontend) pattern and GraphQL. Given these two approaches, which one is the right to consider? Join me in a talk where we will discuss the two approaches, underline both their good and bad sides, and determine which you should consider as the backend technology for your frontend application.

Server Side Responsive Layouts for ASP.NET WebForms using Telerik UI for ASP....

Lohith Goudagere Nagaraj

WSO2 Product Release Webinar - WSO2 App Factory 2.1

WSO2

To view the recording of this webinar please use the below URL: http://wso2.com/library/webinars/2015/03/wso2-product-release-webinar-wso2-app-factory-2.1.0/ In this webinar, Manjula Rathnayaka, associate technical lead, and Kasun De Silva, software engineer at WSO2, will present the following new features and improvements to App Factory 2.1: Adding new application types by including an archive Ability to add runtime externally Puppet scripts for App Factory deployments WSO2 BAM integration for user activity Custom URL improvements

Introduction to SharePoint Framework

Kirti Prajapati

apidays LIVE Paris 2021 - Using OpenAPI to configure your API Gateway by Ole ...

apidays

Branching Your Way to Low-Code Perfection

OutSystems

Designing APIs with OpenAPI Spec

Adam Paxton

Native Touches to your Hybrid Mobile Apps

Lohith Goudagere Nagaraj

Build MSTeams Customizations with SPFx

Kirti Prajapati

Introduction to NativeScript - BuildTruly Native Apps using JavaScript

Lohith Goudagere Nagaraj

Design-first API Development using Swagger and Node

Apigee | Google Cloud

GitHub as a Landing Page

Pronovix

A Starters Guide to Building APIs with Javascript

All Things Open

Presented by: Tom Wilson, hyper63 Presented at the All Things Open Virtual Meetup Abstract: APIs (Application Program Interfaces) is how programs can talk with other programs and is a design consideration for many products. Let’s discuss: Why you should build an application with an API? What are the top 5 requirements of designing an API with examples? Some open-source javascript frameworks that can help you design and build your API. In order to get the most out of this talk, you should have a good understanding of http REST protocol and general application development. Familiarity with javascript and technologies like NodeJS and Express would be a plus. In this talk, you should come away with a good understanding of why you should consider building an API in your application, key good practices every API should include, and how you could implement an API using Javascript.

What's new in Visual Studio 2013 & TFS 2013

Danijel Malik

[API World 2021 ] - Understanding Cloud Native Deployment

WSO2

Microservices and APIs built for digital transformation products require agile, reliable, and scalable cloud native infrastructure to truly meet customer expectations for a great "always there" user experience. Whether deployed on-premises or hosted in a public cloud, understanding and leveraging the right approach is key to success. This session takes up where the development process leaves off, tracking the standardization of containers and container orchestration for automated deployment, including current and future platform trends WSO2 and others are following.

Inflectracon2020: Advantages of Integrating a DevSecOps Pipeline with the Spi...

Inflectra

Welcome to InflectraCon 2020! Please enjoy Inflectra's partner presentation on common DevSecOps pipeline concepts and the integration of a typical pipeline with the Spira family of tools. The key takeaways are: - Explore foundational DevSecOps pipeline concepts, components, and functions. - Understand how the move to DevSecOps can help detect defects before production quickly and prevent continuous bugs. - Learn how you can jump-start your efforts and have a working pipeline on your project. The presentation is by the Inflectra Partner - Coveros. The companion video is available here https://www.youtube.com/watch?v=bTQJtr1Digw

Whats new for developers in Visual Studio 2013

Chris Dufour

There is a ton of new features available in Visual Studio 2013. In this session we will take a look at some of the new enhancements to the IDE including a look at the new “connected” IDE. We will then take a look at the editor productivity enhancements such as the new enhanced scrollbar, Peek Definition and CodeLens. In our final section, we’ll show off some of the cool things the .NET Framework 4.5.1 has enabled in Visual Studio 2013.

What's hot

Lessons learned: Choosing your documentation system

Pronovix

Tools and techniques for APIs

Jason Harmon

Pure APIs: Development workflows for successful API integrations

José Haro Peralta

Getting Started with ASP.NET vNext

Lohith Goudagere Nagaraj

API Conference 2021

José Haro Peralta

GraphQL vs BFF: A critical perspective

Pronovix

Server Side Responsive Layouts for ASP.NET WebForms using Telerik UI for ASP....

Lohith Goudagere Nagaraj

WSO2 Product Release Webinar - WSO2 App Factory 2.1

WSO2

Introduction to SharePoint Framework

Kirti Prajapati

apidays LIVE Paris 2021 - Using OpenAPI to configure your API Gateway by Ole ...

apidays

Branching Your Way to Low-Code Perfection

OutSystems

Designing APIs with OpenAPI Spec

Adam Paxton

Native Touches to your Hybrid Mobile Apps

Lohith Goudagere Nagaraj

Build MSTeams Customizations with SPFx

Kirti Prajapati

Introduction to NativeScript - BuildTruly Native Apps using JavaScript

Lohith Goudagere Nagaraj

Design-first API Development using Swagger and Node

Apigee | Google Cloud

GitHub as a Landing Page

Pronovix

A Starters Guide to Building APIs with Javascript

All Things Open

What's new in Visual Studio 2013 & TFS 2013

Danijel Malik

[API World 2021 ] - Understanding Cloud Native Deployment

WSO2

What's hot (20)

Lessons learned: Choosing your documentation system

Tools and techniques for APIs

Pure APIs: Development workflows for successful API integrations

Getting Started with ASP.NET vNext

API Conference 2021

GraphQL vs BFF: A critical perspective

Server Side Responsive Layouts for ASP.NET WebForms using Telerik UI for ASP....

WSO2 Product Release Webinar - WSO2 App Factory 2.1

Introduction to SharePoint Framework

apidays LIVE Paris 2021 - Using OpenAPI to configure your API Gateway by Ole ...

Branching Your Way to Low-Code Perfection

Designing APIs with OpenAPI Spec

Native Touches to your Hybrid Mobile Apps

Build MSTeams Customizations with SPFx

Introduction to NativeScript - BuildTruly Native Apps using JavaScript

Design-first API Development using Swagger and Node

GitHub as a Landing Page

A Starters Guide to Building APIs with Javascript

What's new in Visual Studio 2013 & TFS 2013

[API World 2021 ] - Understanding Cloud Native Deployment

Similar to API SDK Development – Lessons Learned

Inflectracon2020: Advantages of Integrating a DevSecOps Pipeline with the Spi...

Inflectra

Whats new for developers in Visual Studio 2013

Chris Dufour

Devops Days, 2019 - Charlotte

botsplash.com

Introductie Visual Studio ALM 2012

Twice. Ontwikkelaars van IT professionals

Twice vertelt u in een korte intensieve sessie meer over ALM en Team Foundation Server. In dit seminar is gedemonstreerd wat de nieuwe mogelijkheden zijn van Visual Studio 2012 en Visual Studio 2012 Team Foundation Server. Team Foundation Server ondersteunt de gehele Lifecycle van het applicatie ontwikkeltraject op basis van het Agile gedachtegoed. Er is onder andere ingegaan op de verbeterde samenwerkingsmogelijkheden, het beheer van de source code en het applicatie testproces. Onderwerpen die behandeld zullen worden tijdens dit seminar: • Agile Dashboards • Drag/Drop Storyboards en Taskboards • Ondersteuning voor meerdere teams • Betere offline Version Control d.m.v. local workspaces • Exploratory Testing • Feedback Manager • Geïntegreerde Code Review • Vernieuwde IDE • Integratie met verschillende Unit Test Frameworks • Suspend/Resume work binnen Visual Studio

Introductie Visual Studio ALM 2012

Delta-N

Seminar over ALM en Team Foundation Server In dit seminar wordt gedemonstreerd wat de nieuwe mogelijkheden zijn van Visual Studio 2012 en Visual Studio 2012 Team Foundation Server. Team Foundation Server ondersteunt de gehele Lifecycle van het applicatie ontwikkeltraject op basis van het Agile gedachtegoed. Er wordt onder andere ingegaan op de verbeterde samenwerkingsmogelijkheden, het beheer van de source code en het applicatie testproces. Onderwerpen die behandeld worden tijdens dit seminar zijn: - Agile dashboards - Drag/drop storyboards en Taskboards - Ondersteuning voor meerdere teams - betere offline version control d.m.v. local workspaces - Exploratory testing - Feedback manager - Geïntegreerde code review - Vernieuwde IDE - Integratie met verschillende Unit Test Frameworks -Suspend/Resume work binnen Visual Studio

Using BladeRunnerJS to Build Front-End Apps that Scale - Fluent 2014

Phil Leggetter

Developing large apps is difficult. Ensuring that code is consistent, well structured, tested and has an architecture that encourages enhancement and maintainability is essential. When it comes to building large server-focused apps the solutions to this problem have been tried and tested. But, how do you achieve this when building HTML5 single page apps? BladeRunnerJS is an open source developer toolkit and lightweight front-end framework that has helped Caplin Systems ensure that a 200k LoC JavaScript codebase hasn’t become a tangled mess of unstable spaghetti code. This codebase is packaged and delivered to customers as an SDK. Additionally customers receive a getting started application of around 50k LoC for them to build upon, and they’re expected not to turn that into a tangled … you get the idea. In this talk you’ll learn the main concepts to apply when building a front-end app that scales and how BladeRunnerJS can support the development process.

Modern Web-site Development Pipeline

GlobalLogic Ukraine

Topics of this presentation: - Basics and best practices of developing single-page applications (SPA) and Web API Services on Microsoft .NET - - Core with Docker and Linux. - PowerShell Core automated builds. - Markdown/PDF documentation. - Documentation of public interfaces with Swagger/OAS/YAML. - Automated testing of SPA on Protractor and testing the Web API on Postman/Newman. This presentation by Sergii Fradkov (Consultant, Engineering), Andrii Zarharov (Lead Software Engineer, Consultant), Igor Magdich (Lead Test Engineer, Consultant) was delivered at GlobalLogic Kharkiv .NET TechTalk #1 on May 24, 2019.

Acing application lifecycle management in SharePointJeremy Thake

How to build a JavaScript toolkit

Michael Nelson

Run Your Oracle BI QA Cycles More Effectively

KPI Partners

How does one QA an OBI system? Many project teams struggle to plan out the steps and types of tests they will need to efficiently drive an efficient QA cycle. Learn about the different facets of your BI system and how to properly QA each layer. Special attention will be paid to Data testing and OBI Ad-hoc testing. Speaker: Jeff McQuigg, Solutions Architect, KPI Partners Delivered at BIWA Summit 2013

PHP Framework Battle

Achievers Tech

Scribe online 03 scribe online cdk and api overview

Scribe Software Corp.

SharePoint 2010 – Installation and maintenance – best practices

Toni Frankola

Upgrading to Team Foundation Server (TFS) 2012 – What You Need to Know! (07-2...

Imaginet

Microsoft Visual Studio 2012 brings a number of new features into the integrated ALM toolset. With new features like PowerPoint Storyboarding, Integrated Code Review Features, Stakeholder Feedback, and a newly integrated Developer / Operations Workflow, you will quickly find many reasons to upgrade to Visual Studio and Team Foundation Server 2012! In this webinar, we’ll briefly discuss the breadth of new ALM features. Come join us for this free Webinar!

Emulators as an Emerging Best Practice for API providers

Postman

"Modern applications are highly distributed. We face challenges related to the use of internal and external APIs and how to build APIs with agility in the face of software that can evolve and change at any time. The API industry proposes two common strategies to circumvent these challenges: API Mocking and Service Virtualization. Both have pros and cons. At Cisco, we came up with the idea of API emulators has a third strategy to handle the challenges we were facing. As a result of our work, we published a reference implementation for Webex ChatBots. In this talk, we'll explain the motivation behind API emulators in the perspective of DevOps, CI/CD, Software Development, and serverless/microservices architectures. I will elaborate on the idea of integrating emulators as part of an overall API strategy, dive into the process of building such emulators, and validating them with Postman."

Seng 123 1-concepts

Atilla Elçi

ALM with TFS: From the Drawing Board to the Cloud

Jeremy Likness

Managing the lifecycle of software development can be a daunting task, especially after having adopted an Agile methodology that has you moving faster than ever. That is why it is more important than ever to have the right tools in place that allow you to effectively manage all facets of your SDLC from requirements gathering to testing and deployment. In the suite of tools available in the space of Application Lifecycle Management (ALM), Team Foundation Server (TFS) is a stand out. Let us show you how your organization can benefit from the advanced capabilities and unique configurability of TFS to successfully deliver your software development projects on time and on budget.

A Day in the Life: Developer Enhancements with Visual Studio 2012

Imaginet

Azure Integration DTAP Series, How to go from Development to Production – Par...

BizTalk360

A series of sessions with focus on how to set up a Build & Release setup for Common integration parts with VSTS. In these sessions all will be made hands on and focus will be on understanding the quirks and common tasks. For Azure Functions we will Create Functions, check in the options we have to extract the code. Create a Build and Release setup inside VSTS to move/promote the API to next step/environment in the chain.

Solit 2012, Salesforce.com: 10 причин стать "облачным" программистом, Бондаре...solit

Similar to API SDK Development – Lessons Learned (20)

Inflectracon2020: Advantages of Integrating a DevSecOps Pipeline with the Spi...

Whats new for developers in Visual Studio 2013

Devops Days, 2019 - Charlotte

Introductie Visual Studio ALM 2012

Using BladeRunnerJS to Build Front-End Apps that Scale - Fluent 2014

Modern Web-site Development Pipeline

Acing application lifecycle management in SharePoint

How to build a JavaScript toolkit

Run Your Oracle BI QA Cycles More Effectively

PHP Framework Battle

Scribe online 03 scribe online cdk and api overview

SharePoint 2010 – Installation and maintenance – best practices

Upgrading to Team Foundation Server (TFS) 2012 – What You Need to Know! (07-2...

Emulators as an Emerging Best Practice for API providers

Seng 123 1-concepts

ALM with TFS: From the Drawing Board to the Cloud

A Day in the Life: Developer Enhancements with Visual Studio 2012

Azure Integration DTAP Series, How to go from Development to Production – Par...

Solit 2012, Salesforce.com: 10 причин стать "облачным" программистом, Бондаре...

More from Pronovix

By the time they're reading the docs, it's already too late

Pronovix

Your relationship with a developer begins before they even know your product's name. In fact, before they know they need a product like yours. In this talk, Matthew will make the case that developer marketing, developer experience, and developer education are part of a continuum. And that if you're thinking of documentation as something that happens only after someone has signed-up for your API, then you're leaving it too late. He'll draw on pedagogical and marketing research to propose a model for the developer learning journey where traditional API documentation is just one stop along the way. Attend this talk and you'll come away with practical ideas for how to start educating developers earlier in their product evaluation and learning journey.

Optimizing Dev Portals with Analytics and Feedback

Pronovix

Success metrics when launching your first developer portal

Pronovix

Building our a developer portal may seem easy at the onset with off the shelf options, but when you're building a custom portal to match the needs of your company, it's not as easy. In this session, we'll talk about our process in determining the right places to start with success metrics and features through an early stage feedback back before having customers. You'll see our intention is to tell a story with multiple facets for multiple people, developers, product managers, C suite decision makers etc... Stories around API usage, health, cost, errors and support to provide our users with an overall of their business performance through our APIs.

Documentation, APIs & AI

Pronovix

AI is entering the world of APIs, where API documentation plays a critical role. One of the fundamental challenges is the need to share understanding about an API and keep the knowledge up to date. AI can potentially speed up API integrations dramatically, but it greatly depends on API documentation. Let's explore the emerging approach to employing AI in APIs, discuss its impact on API documentation, and see how changing our way of working with APIs will lead to self-integrating applications.

Making sense of analytics for documentation pages

Pronovix

As content producers, we invest considerable time and effort in developing, packaging, and delivering content that we think our users need. After publishing the content, we hope that users find our content useful. And we often wonder how users really navigate and consume our content. Web page analytics can help us gauge the information needs of our customers, assess their content consumption behavior, and find opportunities to improve our content and how we deliver it. Kumar explores the basics of web analytics, pitfalls of relying too much on web analytics for important decisions, the typical web analytics process, and he will share some guidelines for interpreting web analytics numbers.

Feedback cycles and their role in improving overall developer experiences

Pronovix

Drawing from experiences from open source work and her time at Spotify, Serah’s talk cover the challenges, opportunities and hacks around proactive and reactive monitoring, processing, tracking and acting on stakeholder and community feedback, and argue for the centricity of well-defined feedback loops in improving the overall developer experiences for any product and features you are responsible for.

GraphQL Isn't An Excuse To Stop Writing Docs

Pronovix

The main goal of API documentation is to help developers understand how to use an API. With GraphQL, developers often assume it's self-documenting capabilities are sufficient for anyone that consumes their GraphQL API. But did you ever validate this? Good API documentation offers both static and interactive ways to learn how to consume the API. API's that support GraphQL often only come with interactive documentation, in the shape of a GraphiQL Playground. However, the first time you (or your users) use a GraphQL API can be very frustrating as GraphQL APIs typically only have an interactive playground. it increases the complexity for newcomers to GraphQL as it assumes you’re already familiar with GraphQL. But with GraphQL, you’re not limited to just an interactive playground, as you can create static or interactive documentation next to having this playground. This talk explores which forms of documentation you can use and how they add value to your GraphQL API.

API Documentation For Web3

Pronovix

Web3 is one of the fastest-growing spaces on the web right now, with thousands of new projects emerging every week. Each project aims to fill a gap in the space by providing a new technology How do we keep up with documentation, and what should be prioritized for these projects as they scale? Web3, also referred to as the read-write-own web, is a new form of the internet that utilizes technologies such as blockchain networks, cryptocurrency, crypto wallets, and digital assets like NFTs. The Web3 space is growing by the thousands every week, with new projects and technologies constantly emerging. As writers, it can be challenging to navigate through the space, make sense of every piece of new content, and understand what should be written about for others to read, and what will be irrelevant next week. Many of these new technologies are using pieces of code known as smart contracts or interacting with the APIs of multiple applications at once. What documentation are end-users looking for, and what is the most beneficial format for them to read and comprehend all of this new information? In this talk, I'll discuss what I've learned as a Senior Technical Writer for Filebase, a decentralized cloud storage provider at the heart of hundreds of Web3 projects, and what our customers have benefited from the most when it comes to documentation.

Why your API doesn’t solve my problem: A use case-driven API design

Pronovix

API docs frequently fail to address developers’ needs by omitting common usage scenarios and use cases. Let’s take a look at good and bad practices for documenting API use cases, and take steps to ensure that developers get from our API and docs what they really want. You wrote an API specification, documented your endpoints, and published SDKs. Here’s a question, though: Does your API actually solve your users’ problems? API providers often fail to address common use cases to solve users’ needs, or their assumptions don’t match the reality. This may end up in frustration and loss of users. In this talk, we will take a peek into developers’ mindset. I will show how to better understand the developers’ needs by researching the usage patterns, existing libraries and 3rd party experience layers, provide examples of good and bad practices, and suggest actionable steps to improve developer experience for your API.

unREST among the docs

Pronovix

Developing a best-in-class deprecation policy for your APIs

Pronovix

Nobody likes ambiguity—especially when it comes to the stability of APIs and the expectations for availability long term. Avoid common pitfalls and explore a critical area where trust is built with developers through thoughtful policy and the development of best-in-class documentation. A good deprecation policy involves a lot of forward thinking and an awareness of how developers or end users are currently leveraging your capabilities, and how a given API or feature deprecation could affect them in the future. The hard-earned trust that you’ve built and maintained with these individuals is at risk with any type of policy or documentation that is unclear. The road to developing a clear, trustworthy deprecation policy is a multi-faceted initiative with input from product, engineering, customer success and other cross-functional teams, as well as external market awareness. Knowing which voices to have in the room, what the industry standards are, and formulating appropriate communication timelines will ensure a world class policy is developed and documented before it’s needed. Join us as we dive into the nuances of this process and how to avoid the common pitfalls that come from lacking a strategic, thoughtful approach to documenting a deprecation policy for your APIs.

Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone

Pronovix

At MongoDB, we now generate REST API references for MongoDB Atlas from annotations in the product’s source. Our team’s writers proposed, planned, led, and implemented this project–and learned a lot along the way. We’ll share how we got buy-in from engineering and product stakeholders, coordinated the project across teams, implemented swagger-core annotations in Java, and drove positive change to benefit our team, the company, and our users.

What do developers do when it comes to understanding and using APIs?

Pronovix

It turns out there is no single answer. Developers may have unique goals, motivations, constraints, and challenges, and all of these influence how they approach the problem in front of them. However, more than a decade ago, three development styles were identified - systematic, pragmatic, and opportunistic - and the academic literature suggests that these still exist today. Two of the three approaches, the systematic and the opportunistic pattern, can be considered as opposite extremes, while the pragmatic approach is situated in between and is similar to both. It is not a personality trait - people may approach a situation one way or another depending on their circumstances, goals, and motivations (however, they may also have a preferred approach, which is usually their characteristic). Understanding the differences between these patterns (and the different needs) helps us to design in a way that serves most of the users, and even helps them to get into a state of flow by providing the optimal level of challenge to solve their problem.

Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations

Pronovix

It's time to take the bias out of code, UI, docs, configurations, or our everyday language by ensuring we choose our words carefully to avoid harmful subtext or exclusion. We can do our part and take steps by examining assets from code to config files to API specifications to standards. Heard of suss? You can suss out more information or you can find someone's information to be suss. "Suss" shows the flexibility of language. It’s an ongoing process to change how we use certain words. It's important to choose words carefully to convey the correct meaning and avoid harmful subtext or exclusion. Let's explore some of the tools and triage methods that it takes from an engineering viewpoint to make bias-free choices. How can you ensure that biased words do not sneak into code, UI, docs, configurations, or our everyday language? First, let's walk through how to take an inventory of assets from code to config files to API specifications to standards. Next, by placing those findings into categories, prioritize the work to substitute with inclusive alternatives. Let's examine some examples using both API and code assets. Next is a demonstration of how to automate analyzing your source code or documentation with a linter, looking for patterns based on rules that are fed into the tool. What's in the future for these efforts? Inclusive language should expand beyond English and North America efforts. To do so, let's organize the work with automation tooling, as engineers do.

Creating API documentation for international communities

Pronovix

How to create documentation and write code for an international audience, not just the people who speak and think like you. Make your APIs more useful for everyone on the planet. Much of the documentation supplied by both Open Source and Close Souce projects assume the community have a good understanding of the English language and often North American culture as well. This creates barriers for many solution providers, who are the gateway to potentially huge markets for your project. This talk discusses some of the cultural differences, particularly for people from Asia, in using English language API documentation. It suggests some strategies to help diverse audiences understand you APIs and create solutions using them. The talk will cover not only differences in language but also other cultural differences that are often not obvious. For example: Different expectations about publication formats, release processes, levels of support during the development process Meeting and communications styles Software development workflows, processes, and tools Supporting people who are visually impaired will also be briefly discussed. As well as discussing these issues, specific suggestions will be provided to make API docs accessible for as many people as possible. This talk is based on Alec's work with customers in Europe, North America, Middle East, Asia, and Australasia. The last five have been spent as a developer evangelist working with PaperCut partners in China, Japan, Korea, US and Europe.

One Developer Portal to Document Them All

Pronovix

APIs in a modern enterprise are rarely uniform or all of the same type. The multitude of API types can be due to organic growth, mergers and acquisitions, or any number of other reasons. Regardless of their origin, APIs of all types need to be fully documented to facilitate a developer’s journey as they interact with your API ecosystem in order to develop useful applications. In this talk I will show examples of how we have augmented developer portals to document APIs that are not of the REST variety, such as AsyncAPI, GraphQL, SOAP, gRPC, and more, such that all API documentation can seamlessly live side-by-side.

Docs-as-Code: Evolving the API Documentation Experience

Pronovix

We are a software engineering team creating API docs. Docs are authored using Instructional Design principles to narrate use-cases and practical API implementations. This talk shares why & how we've applied software development practices to evolve our document tooling, creation, & delivery methods. Our APIs describe asynchronous protocols used for embedded software (firmware) components in a digital 2-way radio communications system. The API is protocol data unit (PDU) based and its definition is described in a proprietary format; consequently, well-known API formats, such as Swagger/OpenAPI, or tools, such as doxygen, are not used. Our product training and technical writing teams are very experienced in Instructional Design methods, but these teams have only written documentation for an end-user audience. Understanding software development processes is equally important as understanding two-way radio networks in order to successfully integrate with the APIs. This is the rationale for having a software engineering team develop the skillsets to write API documentation for a developer audience. With a solid foundation of API documentation in place, regular examination of engineering efficiency and developer experience is appropriate. Repeated actions can be replaced by automation. Content can be modular and re-usable. Formats can be streamlined for easier consumption. Docs can be made portable and lightweight for faster delivery.

Developer journey - make it easy for devs to love your product

Pronovix

Ever wonder how some products are just lovable and easy to use while other are not? The good products have optimized onboarding into their ecosystem where you get the information served at the right time. That’s thanks to developer journey and we will teach you how to get it right! We will go through the basics such as how to analyze existing and non-existing developer touchpoints, set metrics and optimize them to increase the conversion.

Complexity is not complicatedness

Pronovix

Deliberate Complexity Conferences - 19 JULY 2022 Alicia Juarrero - Complexity is not complicatedness Professor Alicia Juarrero, a leading complexity theory philosopher and academic, as well as the founder and president of VectorAnalytica, a technology company that specializes in large scale scientific data capture and real time analysis tools. Alicia's work in complexity theory is widely quoted by thought leaders in the technology space and referenced in many recent complexity-informed approaches for managing highly dynamic systems, as well as in knowledge management.

How cognitive biases and ranking can foster an ineffective architecture and d...

Pronovix

More from Pronovix (20)

By the time they're reading the docs, it's already too late

Optimizing Dev Portals with Analytics and Feedback

Success metrics when launching your first developer portal

Documentation, APIs & AI

Making sense of analytics for documentation pages

Feedback cycles and their role in improving overall developer experiences

GraphQL Isn't An Excuse To Stop Writing Docs

API Documentation For Web3

Why your API doesn’t solve my problem: A use case-driven API design

unREST among the docs

Developing a best-in-class deprecation policy for your APIs

Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone

What do developers do when it comes to understanding and using APIs?

Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations

Creating API documentation for international communities

One Developer Portal to Document Them All

Docs-as-Code: Evolving the API Documentation Experience

Developer journey - make it easy for devs to love your product

Complexity is not complicatedness

How cognitive biases and ranking can foster an ineffective architecture and d...

Recently uploaded

Ransomware Mallox [EN].pdf

Overkill Security

The infamous Mallox is the digital Robin Hoods of our time, except they steal from everyone and give to themselves. Since mid-2021, they've been playing hide and seek with unsecured Microsoft SQL servers, encrypting data, and then graciously offering to give it back for a modest Bitcoin donation. Mallox decided to go shopping for new malware toys, adding the Remcos RAT, BatCloak, and a sprinkle of Metasploit to their collection. They're now playing a game of "Catch me if you can" with antivirus software, using their FUD obfuscator packers to turn their ransomware into the digital equivalent of a ninja. ------- This document provides a analysis of the Target Company ransomware group, also known as Smallpox, which has been rapidly evolving since its first identification in June 2021. The analysis delves into various aspects of the group's operations, including its distinctive practice of appending targeted organizations' names to encrypted files, the evolution of its encryption algorithms, and its tactics for establishing persistence and evading defenses. The insights gained from this analysis are crucial for informing defense strategies and enhancing preparedness against such evolving cyber threats.

AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...

Product School

Connector Corner: Automate dynamic content and events by pushing a button

DianaGray10

Here is something new! In our next Connector Corner webinar, we will demonstrate how you can use a single workflow to: Create a campaign using Mailchimp with merge tags/fields Send an interactive Slack channel message (using buttons) Have the message received by managers and peers along with a test email for review But there’s more: In a second workflow supporting the same use case, you’ll see: Your campaign sent to target colleagues for approval If the “Approve” button is clicked, a Jira/Zendesk ticket is created for the marketing design team But—if the “Reject” button is pushed, colleagues will be alerted via Slack message Join us to learn more about this new, human-in-the-loop capability, brought to you by Integration Service connectors. And... Speakers: Akshay Agnihotri, Product Manager Charlie Greenberg, Host

Smart TV Buyer Insights Survey 2024 by 91mobiles.pdf

91mobiles

Assuring Contact Center Experiences for Your Customers With ThousandEyes

ThousandEyes

Mission to Decommission: Importance of Decommissioning Products to Increase E...

Product School

UiPath New York Community Day in-person event

DianaGray10

UiPath Community Day is a unique gathering designed to foster collaboration, learning, and networking with automation enthusiasts. Whether you're an automation developer, business analyst, IT professional, solution architect, CoE lead, practitioner or a student/educator excited about the prospects of artificial intelligence and automation technologies in the United States, then the UiPath Community Day is definitely the place you want to be. Join UiPath leaders, experts from the industry, and the amazing community members and let's connect over expert sessions, demos and use cases around AI in automation as we highlight our technology with a special speaker on Document Understanding. 📌Agenda 3:00 PM Registrations 3:30 PM Welcome note and Introductions | Corina Gheonea (Senior Director of Global UiPath Community) 4:00 PM Introduction to Document Understanding How to build and deploy Document Understanding process Where would Document Understanding be used. Demo Q&A 4:45 PM Customer/Partner showcase Accelirate Intro to Accelirate and history with UiPath Why are we excited about the new AI features of UiPath? Customer highlight a. Document Understanding – BJs Case Study b. Document Understanding + generative AI 5.30 PM Networking

Future Visions: Predictions to Guide and Time Tech Innovation, Peter Udo Diehl

Peter Udo Diehl

I'm excited to share my latest predictions on how AI, robotics, and other technological advancements will reshape industries in the coming years. The slides explore the exponential growth of computational power, the future of AI and robotics, and their profound impact on various sectors. Why this matters: The success of new products and investments hinges on precise timing and foresight into emerging categories. This deck equips founders, VCs, and industry leaders with insights to align future products with upcoming tech developments. These insights enhance the ability to forecast industry trends, improve market timing, and predict competitor actions. Highlights: ▪ Exponential Growth in Compute: How $1000 will soon buy the computational power of a human brain ▪ Scaling of AI Models: The journey towards beyond human-scale models and intelligent edge computing ▪ Transformative Technologies: From advanced robotics and brain interfaces to automated healthcare and beyond ▪ Future of Work: How automation will redefine jobs and economic structures by 2040 With so many predictions presented here, some will inevitably be wrong or mistimed, especially with potential external disruptions. For instance, a conflict in Taiwan could severely impact global semiconductor production, affecting compute costs and related advancements. Nonetheless, these slides are intended to guide intuition on future technological trends.

FIDO Alliance Osaka Seminar: FIDO Security Aspects.pdf

FIDO Alliance

The Art of the Pitch: WordPress Relationships and Sales

Laura Byrne

Clients don’t know what they don’t know. What web solutions are right for them? How does WordPress come into the picture? How do you make sure you understand scope and timeline? What do you do if sometime changes? All these questions and more will be explored as we talk about matching clients’ needs with what your agency offers without pulling teeth or pulling your hair out. Practical tips, and strategies for successful relationship building that leads to closing the deal.

PHP Frameworks: I want to break free (IPC Berlin 2024)

Ralf Eggert

In this presentation, we examine the challenges and limitations of relying too heavily on PHP frameworks in web development. We discuss the history of PHP and its frameworks to understand how this dependence has evolved. The focus will be on providing concrete tips and strategies to reduce reliance on these frameworks, based on real-world examples and practical considerations. The goal is to equip developers with the skills and knowledge to create more flexible and future-proof web applications. We'll explore the importance of maintaining autonomy in a rapidly changing tech landscape and how to make informed decisions in PHP development. This talk is aimed at encouraging a more independent approach to using PHP frameworks, moving towards a more flexible and future-proof approach to PHP development.

Slack (or Teams) Automation for Bonterra Impact Management (fka Social Soluti...

Jeffrey Haguewood

Sidekick Solutions uses Bonterra Impact Management (fka Social Solutions Apricot) and automation solutions to integrate data for business workflows. We believe integration and automation are essential to user experience and the promise of efficient work through technology. Automation is the critical ingredient to realizing that full vision. We develop integration products and services for Bonterra Case Management software to support the deployment of automations for a variety of use cases. This video focuses on the notifications, alerts, and approval requests using Slack for Bonterra Impact Management. The solutions covered in this webinar can also be deployed for Microsoft Teams. Interested in deploying notification automations for Bonterra Impact Management? Contact us at sales@sidekicksolutionsllc.com to discuss next steps.

The Future of Platform Engineering

Jemma Hussein Allen

From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...

Product School

Key Trends Shaping the Future of Infrastructure.pdf

Cheryl Hung

FIDO Alliance Osaka Seminar: Passkeys and the Road Ahead.pdf

FIDO Alliance

Accelerate your Kubernetes clusters with Varnish Caching

Thijs Feryn

Neuro-symbolic is not enough, we need neuro-*semantic*

Frank van Harmelen

Neuro-symbolic (NeSy) AI is on the rise. However, simply machine learning on just any symbolic structure is not sufficient to really harvest the gains of NeSy. These will only be gained when the symbolic structures have an actual semantics. I give an operational definition of semantics as “predictable inference”. All of this illustrated with link prediction over knowledge graphs, but the argument is general.

Knowledge engineering: from people to machines and back

Elena Simperl

GraphRAG is All You need? LLM & Knowledge Graph

Guy Korland

Guy Korland, CEO and Co-founder of FalkorDB, will review two articles on the integration of language models with knowledge graphs. 1. Unifying Large Language Models and Knowledge Graphs: A Roadmap. https://arxiv.org/abs/2306.08302 2. Microsoft Research's GraphRAG paper and a review paper on various uses of knowledge graphs: https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/

Recently uploaded (20)

Ransomware Mallox [EN].pdf

AI for Every Business: Unlocking Your Product's Universal Potential by VP of ...

Connector Corner: Automate dynamic content and events by pushing a button

Smart TV Buyer Insights Survey 2024 by 91mobiles.pdf

Assuring Contact Center Experiences for Your Customers With ThousandEyes

Mission to Decommission: Importance of Decommissioning Products to Increase E...

UiPath New York Community Day in-person event

Future Visions: Predictions to Guide and Time Tech Innovation, Peter Udo Diehl

FIDO Alliance Osaka Seminar: FIDO Security Aspects.pdf

The Art of the Pitch: WordPress Relationships and Sales

PHP Frameworks: I want to break free (IPC Berlin 2024)

Slack (or Teams) Automation for Bonterra Impact Management (fka Social Soluti...

The Future of Platform Engineering

From Daily Decisions to Bottom Line: Connecting Product Work to Revenue by VP...

Key Trends Shaping the Future of Infrastructure.pdf

FIDO Alliance Osaka Seminar: Passkeys and the Road Ahead.pdf

Accelerate your Kubernetes clusters with Varnish Caching

Neuro-symbolic is not enough, we need neuro-*semantic*

Knowledge engineering: from people to machines and back

GraphRAG is All You need? LLM & Knowledge Graph

API SDK Development – Lessons Learned

1. API SDK Development - Lessons Learned Jaap Brasser – Developer Advocate

4. ▪ Rubrik APIs ▪ The Goal ▪ Challenges ▪ Lessons Learned ▪ Questions

5. Rubrik APIs

6. ▪ Backup & Restore ▪ Cloud Data Management ▪ Disaster Recovery ▪ Test-Dev scenarios ▪ CI/CD Integration

7. ▪ APIs are relatively new here – Legacy tools, executables – Custom modules or integrations – GUIs everywhere ▪ Lack of understanding of the API space

8. ▪ Build from the ground up to be API-first ▪ Good! ▪ API endpoints classified as internal ▪ Not good! ▪ OpenAPI Spec ▪ Excellent!

9. The Goal

10. Session Management No Direct API Calls Structured Output Different Users

11.

12.

13.

14.

15. Ease of Updating Build Tooling on SDK Extend SDK based on tools

16. Open Source Unit tests Documentation

17. The Challenges

18. Team Enablement Open Source Management Bugs in APIs New API versions

19. Security of SDK Automate everything Branching and Releases

20. Lessons Learned

21. Create coding & contribution standards 01 Enforce Unit Tests 02 Enable the contributiors 03 Integrations & Tooling improvements 04 Issues and Contributions Time! 05 Do not automate everything 06

22. jaap_brasser jaapbrasser

API SDK Development – Lessons Learned

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to API SDK Development – Lessons Learned

Similar to API SDK Development – Lessons Learned (20)

More from Pronovix

More from Pronovix (20)

Recently uploaded

Recently uploaded (20)

API SDK Development – Lessons Learned