Developer experience (DX) is an extension of general User Experience, which emphasizes the developer, and their experiences working your API. A good API developer experience goes beyond technical writing. It is about providing all the right resources that help your end consumers successfully integrate and work with your API. A well designed developer experience has API documentation at the center of it.
API documentation is the information that is required to successfully consume and integrate with an API. This would be in the form of technical writing, code samples and examples for better understanding how to consume an API.
The OpenAPI Specification is the industry standard API design framework, allowing developers and teams to design, build, document and consume RESTful web services. The OpenAPI Specification is the de facto framework used when API practitioners want to optimize the developer experience.
This talk covers what it means to have an API with good DX by understanding the types of API consumers and their journey from discovery to API integration, and how OpenAPI Spec/Swagger Spec can help in improving general API DX with great documentation.
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...SmartBear
In this webinar session, we showed why API standardization is important and how your organization can use SwaggerHub to overcome the most common challenges with making the move to the OpenAPI Specification.
The document provides an introduction and overview of APIs, REST, and OpenAPI specification. It discusses key concepts like resources, HTTP verbs, and OpenAPI structure. It also demonstrates OpenAPI syntax using JSON and YAML examples and highlights best practices for documenting APIs with OpenAPI.
Delivered at APIStrat Boston 2016
One of the more challenging aspects of working with APIs is that outside of your own little tech bubble, nobody actually knows what an API is - despite being hopelessly dependent on APIs for their day to day lives. So how do you talk about APIs to the masses of people who have no idea what they are? You're going to have to do it - you'll need to talk to your non-technical colleagues about it, many of whom you're entirely dependent upon to improve your API or get it out to the masses; there'll be potential customers out there for whom your API is the exact solution to the problem they're having and there's the people you meet who ask you what it is you do.
In this talk we'll discuss how overcome this huge challenge for all of us in the business of APIs, how to establish not just a clear ubiquitous language when talking about our APIs but clarity and consistency of content - making sure your developers, salespeople, support and marketing are all talking about your APIs in a way that is accessible, meaningful and useful to all concerned, and how that consistency of understanding can be the difference between the success or failure of your API.
Bulletproofing Your APIs: Why Users’ Feedback MattersPronovix
This document discusses the importance of gathering user feedback throughout the API development process. It recommends conducting user interviews early on to understand needs and frustrations. It also suggests usability testing the API prototype to observe how users interact with it and identify issues. Throughout the development stages of concept, design, build, and manage, gathering feedback through methods like card sorting, beta testing, hackathons, surveys, and support channels can help validate the business, refine the product roadmap, and build a strong developer community. The overall message is that listening to users will help uncover blind spots and guide the API design in a positive direction.
APIdays Paris 2019 - Microservices vs Miniservices vs Monoliths: Winner Takes...apidays
The document discusses microservices, miniservices, and monolith architectures. It provides an overview of each approach, including their advantages and disadvantages. Microservices are described as small, independently deployable services that use lightweight protocols. Miniservices are a middle ground that relax some constraints of microservices. Monoliths are single units but can be improved with practices like agile development and DevOps. The document concludes that there is no one-size-fits-all approach and the best solution depends on individual team and project needs.
INTERFACE, by apidays - Low code APIs that don't break by Zdenek Nemec, Supe...apidays
This document discusses how to prevent APIs from breaking by decoupling clients and servers. It recommends:
1. Programming clients for business capabilities rather than technical API details to reduce dependencies on any single API.
2. Representing capabilities, not internal systems, in APIs to minimize the need for changes.
3. Following best practices like defensive programming, retry policies, and redundancy to make clients more resilient to potential API issues.
This approach aims to dramatically reduce codebases, documentation needs, and downtime while increasing API client resilience and competition between providers.
Google v Oracle: The Future of Software and Fair UseAurora Consulting
Breaks down Google v. Oracle and what it means for the future of software development and fair use. This legal contest has been heralded as the “World Series of IP cases” and the “copyright case of the decade”.
It’s a landmark case, 11 years in the making, between two industry heavyweights – Google, the undisputed king of search and mobile operating system market share, accused of both patent and copyright infringement against Oracle, the owner of the ubiquitous Java API.
At stake is a winner take or keep-all purse of $9 billion in damages and a Supreme Court ruling that will dictate the future of software interface copyright law. Ashley Sloat, President & Director of Patent Strategy here at Aurora, serves as your guide, cutting through 11 years of case law, 3 trials, 2 appeals, and endless technology metaphors, all in an illuminating IP conversation that runs the gamut from patent infringement to copyright violation and ultimately settles on a matter of fair use doctrine.
Blog: https://www.aurorapatents.com/blog/new-podcast-google-v-oracle
Podcast: https://patentlystrategic.buzzsprout.com/1734511/8468565-google-v-oracle-the-future-of-software-and-fair-use
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...SmartBear
In this webinar session, we showed why API standardization is important and how your organization can use SwaggerHub to overcome the most common challenges with making the move to the OpenAPI Specification.
The document provides an introduction and overview of APIs, REST, and OpenAPI specification. It discusses key concepts like resources, HTTP verbs, and OpenAPI structure. It also demonstrates OpenAPI syntax using JSON and YAML examples and highlights best practices for documenting APIs with OpenAPI.
Delivered at APIStrat Boston 2016
One of the more challenging aspects of working with APIs is that outside of your own little tech bubble, nobody actually knows what an API is - despite being hopelessly dependent on APIs for their day to day lives. So how do you talk about APIs to the masses of people who have no idea what they are? You're going to have to do it - you'll need to talk to your non-technical colleagues about it, many of whom you're entirely dependent upon to improve your API or get it out to the masses; there'll be potential customers out there for whom your API is the exact solution to the problem they're having and there's the people you meet who ask you what it is you do.
In this talk we'll discuss how overcome this huge challenge for all of us in the business of APIs, how to establish not just a clear ubiquitous language when talking about our APIs but clarity and consistency of content - making sure your developers, salespeople, support and marketing are all talking about your APIs in a way that is accessible, meaningful and useful to all concerned, and how that consistency of understanding can be the difference between the success or failure of your API.
Bulletproofing Your APIs: Why Users’ Feedback MattersPronovix
This document discusses the importance of gathering user feedback throughout the API development process. It recommends conducting user interviews early on to understand needs and frustrations. It also suggests usability testing the API prototype to observe how users interact with it and identify issues. Throughout the development stages of concept, design, build, and manage, gathering feedback through methods like card sorting, beta testing, hackathons, surveys, and support channels can help validate the business, refine the product roadmap, and build a strong developer community. The overall message is that listening to users will help uncover blind spots and guide the API design in a positive direction.
APIdays Paris 2019 - Microservices vs Miniservices vs Monoliths: Winner Takes...apidays
The document discusses microservices, miniservices, and monolith architectures. It provides an overview of each approach, including their advantages and disadvantages. Microservices are described as small, independently deployable services that use lightweight protocols. Miniservices are a middle ground that relax some constraints of microservices. Monoliths are single units but can be improved with practices like agile development and DevOps. The document concludes that there is no one-size-fits-all approach and the best solution depends on individual team and project needs.
INTERFACE, by apidays - Low code APIs that don't break by Zdenek Nemec, Supe...apidays
This document discusses how to prevent APIs from breaking by decoupling clients and servers. It recommends:
1. Programming clients for business capabilities rather than technical API details to reduce dependencies on any single API.
2. Representing capabilities, not internal systems, in APIs to minimize the need for changes.
3. Following best practices like defensive programming, retry policies, and redundancy to make clients more resilient to potential API issues.
This approach aims to dramatically reduce codebases, documentation needs, and downtime while increasing API client resilience and competition between providers.
Google v Oracle: The Future of Software and Fair UseAurora Consulting
Breaks down Google v. Oracle and what it means for the future of software development and fair use. This legal contest has been heralded as the “World Series of IP cases” and the “copyright case of the decade”.
It’s a landmark case, 11 years in the making, between two industry heavyweights – Google, the undisputed king of search and mobile operating system market share, accused of both patent and copyright infringement against Oracle, the owner of the ubiquitous Java API.
At stake is a winner take or keep-all purse of $9 billion in damages and a Supreme Court ruling that will dictate the future of software interface copyright law. Ashley Sloat, President & Director of Patent Strategy here at Aurora, serves as your guide, cutting through 11 years of case law, 3 trials, 2 appeals, and endless technology metaphors, all in an illuminating IP conversation that runs the gamut from patent infringement to copyright violation and ultimately settles on a matter of fair use doctrine.
Blog: https://www.aurorapatents.com/blog/new-podcast-google-v-oracle
Podcast: https://patentlystrategic.buzzsprout.com/1734511/8468565-google-v-oracle-the-future-of-software-and-fair-use
An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesf...Pronovix
23 different REST APIs, 26+ teams, 150+ writers — how we built a unified solution. In this session, hear the inside story of how a handful of writers developed a REST API doc solution and earned the trust of executives and engineering teams across Salesforce along the way.
Classification of Advanced AI and ML Testing Tools - DevOps NextPerfecto by Perforce
AI and ML solutions, whether commercial or open source, typically address unique use case or challenges. Learn about the categorization of testing tools with advanced AI/ML and get examples and existing tools for each of the use cases.
codEnfocer is a cloud based system for source code analysis and improvments. System provides recomendations for source code architecture improvments. Can be used from our cloud server or can be installed on corporate server and can be connected to repositories based on GitHub, SVN and TFS. Have powerful functionality for source code analysis and documentation development. Try codEnforcer at www.codenforcer.com
One of the biggest problems with code reviews is that they often derail developer productivity. Learn about the essentials of code reviews, where they are today, and where they can be using AI/ML technologies. With machine learning technology, code quality can be improved, and developers can focus on invention, rather than remediation.
Subha Chandra has over 10 years of experience as a software engineer working with technologies like Java, Spring, React, and AWS. They are currently a software developer at Quest Global where they design, build, and deploy applications in an agile environment. Previously they held roles at Sonata Software, Capgemini, Teamware Solutions, and Honeywell Technologies where they gained experience in full stack development, REST APIs, microservices, DevOps, and more. They have a Master's in Computer Science and are fluent in English with elementary German skills.
Rest api best practices – comprehensive handbookKaty Slemon
This document provides an overview of REST API best practices. It discusses the key aspects of REST API design, including the 6 architectural constraints of REST (uniform interface, client-server, stateless, cacheable, layered system, and code on demand). It also outlines 12 best practices for REST API design, such as using nouns instead of verbs in URIs, plural naming conventions, implementing HATEOAS, and using Swagger for documentation. The document serves as a comprehensive guide to building robust RESTful APIs.
Vibrant Technologies is headquarted in Mumbai,India.We are the best selenium training provider in Navi Mumbai who provides Live Projects to students.We provide Corporate Training also.We are Best selenium classes in Mumbai according to our students and corporates
Your Developer Portal is the primary interface that developers will have with your company’s product. So what does your developer portal say about you? We’ll share what we’ve learned at BigCommerce about redesigning a developer portal that helps your developers–and your company–meet their goals.
Main focus of the talk is to communicate some key concepts of designing/implementing APIs based on an enterprise grade API Standards and Guidelines. We will try to handcraft few API recipes(i.e. implementation design) with real-life examples mixed with a live coding session. While working on each recipe, we will delve into the rationale behind design decisions and best practices. We believe that these concepts will help a developer build a comprehensive API solution from scratch.
Decrypting Software Patents: Key Insights for IP SuccessAurora Consulting
Software is eating the world. It’s central to so much of today’s innovation, but in terms of patenting, it’s socially controversial and legally unsettled. We’ll discuss the dynamics at the core of both and what you need to know about the options for protecting your software-based innovation. We’ll take an international look at how the "world" views AI/ML innovations and also hit on particulars for SaaS and open source software considerations. From an implementation perspective, we’ll look at managing code ownership when outsourcing and how iterative agile methodology can impact your patent strategy.
apidays LIVE LONDON - Discovering API Version differences with ease by Jaap B...apidays
apidays LIVE LONDON - The Road to Embedded Finance, Banking and Insurance with APIs
Discovering API Version differences with ease
Jaap Brasser, Developer Advocate at Rubrik
Software fuzzing has long been a trusted method for finding vulnerabilities that are difficult to discover using traditional methods. The application of AI and ML to this field has already begun to bear very promising results. Learn the various methods of fuzzing through examples, documentation, and other related data that can guide practitioners on where to start and which tools are ready to be applied today.
Disintermediation. It’s a term we more often use when referring to the removal of intermediaries in economics from a supply chain. It’s how modern companies reduce liability and/or reduce costs. Rather than hiring employees in-house to do the work, they hire a sub-contracting company with different guiding principles.
It may bemuse you to suggest: your API program is probably operating the same way. Different API teams + different guiding principles = different supply chains. Producing their own products. Products that must be compatible with one another. Your customer will insist upon it. Maybe not today, but they will when they begin to scale their application. Can you imagine if a Lego block supply chain was producing a disparate type of Lego block? What if you had a hundred Lego supply chains?
A cohesive set of guiding principles is critical. For your API development teams, your “supply chains.” We’ve become so consumed with getting APIs out the door, getting our developer portal up, we’ve forgotten the most important thing. The human experience of our APIs. Of the app developer. And what app developer would want to use your APIs if they knew that two years down the road, they won’t be able to easily integrate your other supply chains?.
Leah will be talking about the guiding principles that are key to the compatibility of your supply chains. And to the future loyalty to your API program.
Sachin Agarwal, SOA Software VP of Product Marketing, explains the frenzy around the mass development and adoption of APIs. In this presentation, he describes the business and technology implications of developing an API stratgy.
The document discusses measuring documentation success through defining goals, metrics, and iterating based on measurements. It encourages describing goals for different document types in a way that is countable and measurable, like the number of downloads or questions answered. The key takeaways are to collaboratively define success metrics, measure and analyze performance, then revise documentation goals and processes based on the results.
Deviprasad Shetty has over 1.6 years of experience in PCIe IP level verification. He has worked as a contractor for LSI and as a project intern at LSI R&D India. He is proficient in Verilog HDL, Specman E, and has knowledge of PCIe protocols. His education includes an MSc.Tech in VLSI Design from MCIS Manipal and a BE in Electronics and Communication. His projects include PCIe controller verification using Specman and asynchronous FIFO design and verification.
Oracle Developers APAC Meetup #2 - Building API with Apiary
This is the slide deck used for the Oracle APAC Developers Meetup #2 held in Singapore on 28th March 2018.
The slides are intended to be used in conjunction with the hands-on worksheets.
You can find the worksheets at :
https://www.slideshare.net/BoopathyBalasubraman/oracle-apacdevelopersmeetup2buildingapiwithapiaryhandsonworksheet/BoopathyBalasubraman/oracle-apacdevelopersmeetup2buildingapiwithapiaryhandsonworksheet
Meetup Site:
https://www.meetup.com/Oracle-Developers-APAC/events/248288651/
Angular 6 Training with project in hyderabad indiaphp2ranjan
ngularJS is one of the JavaScript open-source web application frameworks which is generally used to add an HTML page along with a tag. The major aim of AngularJS is to simplify the application development and testing performance by providing a framework called MVC (Model View Controller) Architecture. It enables the application to change from bulk amount of programming code into a simple code.
Understanding and Executing on API Developer ExperienceSmartBear
What is Developer Experience, and how can you leverage it to drive adoption and growth for your API? Our very own Keshav Vasudevan will take you through it. Learn more: https://blog.smartbear.com/apis/developer-experience-the-key-to-a-successful-api/
API Developer Experience: Why it Matters, and How Documenting Your API with S...SmartBear
Whether you’re new to Swagger, or have already been using the framework for API design, there’s a good chance you still have questions about how to improve your API documentation. Creating API documentation your consumers will love can take some work, but the investment will have a significant payoff in the form of a great developer experience, easier implementation, and improved adoption of your API.
This presentation covers good developer experience in detail, focusing on why and how to provide an optimal experience for developers using your API. We will also cover how Swagger has changed the API design and documentation landscape, and finally show some good practices for API documentation using Swagger in SwaggerHub’s integrated API development platform.
Things to expect in this webinar:
What is Developer Experience (DX)?
What does it mean for an API to have good DX?
API documentation in the context of good DX?
An introduction to the Swagger framework
Designing APIs from a usability perspective using Swagger and SwaggerHub
An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesf...Pronovix
23 different REST APIs, 26+ teams, 150+ writers — how we built a unified solution. In this session, hear the inside story of how a handful of writers developed a REST API doc solution and earned the trust of executives and engineering teams across Salesforce along the way.
Classification of Advanced AI and ML Testing Tools - DevOps NextPerfecto by Perforce
AI and ML solutions, whether commercial or open source, typically address unique use case or challenges. Learn about the categorization of testing tools with advanced AI/ML and get examples and existing tools for each of the use cases.
codEnfocer is a cloud based system for source code analysis and improvments. System provides recomendations for source code architecture improvments. Can be used from our cloud server or can be installed on corporate server and can be connected to repositories based on GitHub, SVN and TFS. Have powerful functionality for source code analysis and documentation development. Try codEnforcer at www.codenforcer.com
One of the biggest problems with code reviews is that they often derail developer productivity. Learn about the essentials of code reviews, where they are today, and where they can be using AI/ML technologies. With machine learning technology, code quality can be improved, and developers can focus on invention, rather than remediation.
Subha Chandra has over 10 years of experience as a software engineer working with technologies like Java, Spring, React, and AWS. They are currently a software developer at Quest Global where they design, build, and deploy applications in an agile environment. Previously they held roles at Sonata Software, Capgemini, Teamware Solutions, and Honeywell Technologies where they gained experience in full stack development, REST APIs, microservices, DevOps, and more. They have a Master's in Computer Science and are fluent in English with elementary German skills.
Rest api best practices – comprehensive handbookKaty Slemon
This document provides an overview of REST API best practices. It discusses the key aspects of REST API design, including the 6 architectural constraints of REST (uniform interface, client-server, stateless, cacheable, layered system, and code on demand). It also outlines 12 best practices for REST API design, such as using nouns instead of verbs in URIs, plural naming conventions, implementing HATEOAS, and using Swagger for documentation. The document serves as a comprehensive guide to building robust RESTful APIs.
Vibrant Technologies is headquarted in Mumbai,India.We are the best selenium training provider in Navi Mumbai who provides Live Projects to students.We provide Corporate Training also.We are Best selenium classes in Mumbai according to our students and corporates
Your Developer Portal is the primary interface that developers will have with your company’s product. So what does your developer portal say about you? We’ll share what we’ve learned at BigCommerce about redesigning a developer portal that helps your developers–and your company–meet their goals.
Main focus of the talk is to communicate some key concepts of designing/implementing APIs based on an enterprise grade API Standards and Guidelines. We will try to handcraft few API recipes(i.e. implementation design) with real-life examples mixed with a live coding session. While working on each recipe, we will delve into the rationale behind design decisions and best practices. We believe that these concepts will help a developer build a comprehensive API solution from scratch.
Decrypting Software Patents: Key Insights for IP SuccessAurora Consulting
Software is eating the world. It’s central to so much of today’s innovation, but in terms of patenting, it’s socially controversial and legally unsettled. We’ll discuss the dynamics at the core of both and what you need to know about the options for protecting your software-based innovation. We’ll take an international look at how the "world" views AI/ML innovations and also hit on particulars for SaaS and open source software considerations. From an implementation perspective, we’ll look at managing code ownership when outsourcing and how iterative agile methodology can impact your patent strategy.
apidays LIVE LONDON - Discovering API Version differences with ease by Jaap B...apidays
apidays LIVE LONDON - The Road to Embedded Finance, Banking and Insurance with APIs
Discovering API Version differences with ease
Jaap Brasser, Developer Advocate at Rubrik
Software fuzzing has long been a trusted method for finding vulnerabilities that are difficult to discover using traditional methods. The application of AI and ML to this field has already begun to bear very promising results. Learn the various methods of fuzzing through examples, documentation, and other related data that can guide practitioners on where to start and which tools are ready to be applied today.
Disintermediation. It’s a term we more often use when referring to the removal of intermediaries in economics from a supply chain. It’s how modern companies reduce liability and/or reduce costs. Rather than hiring employees in-house to do the work, they hire a sub-contracting company with different guiding principles.
It may bemuse you to suggest: your API program is probably operating the same way. Different API teams + different guiding principles = different supply chains. Producing their own products. Products that must be compatible with one another. Your customer will insist upon it. Maybe not today, but they will when they begin to scale their application. Can you imagine if a Lego block supply chain was producing a disparate type of Lego block? What if you had a hundred Lego supply chains?
A cohesive set of guiding principles is critical. For your API development teams, your “supply chains.” We’ve become so consumed with getting APIs out the door, getting our developer portal up, we’ve forgotten the most important thing. The human experience of our APIs. Of the app developer. And what app developer would want to use your APIs if they knew that two years down the road, they won’t be able to easily integrate your other supply chains?.
Leah will be talking about the guiding principles that are key to the compatibility of your supply chains. And to the future loyalty to your API program.
Sachin Agarwal, SOA Software VP of Product Marketing, explains the frenzy around the mass development and adoption of APIs. In this presentation, he describes the business and technology implications of developing an API stratgy.
The document discusses measuring documentation success through defining goals, metrics, and iterating based on measurements. It encourages describing goals for different document types in a way that is countable and measurable, like the number of downloads or questions answered. The key takeaways are to collaboratively define success metrics, measure and analyze performance, then revise documentation goals and processes based on the results.
Deviprasad Shetty has over 1.6 years of experience in PCIe IP level verification. He has worked as a contractor for LSI and as a project intern at LSI R&D India. He is proficient in Verilog HDL, Specman E, and has knowledge of PCIe protocols. His education includes an MSc.Tech in VLSI Design from MCIS Manipal and a BE in Electronics and Communication. His projects include PCIe controller verification using Specman and asynchronous FIFO design and verification.
Oracle Developers APAC Meetup #2 - Building API with Apiary
This is the slide deck used for the Oracle APAC Developers Meetup #2 held in Singapore on 28th March 2018.
The slides are intended to be used in conjunction with the hands-on worksheets.
You can find the worksheets at :
https://www.slideshare.net/BoopathyBalasubraman/oracle-apacdevelopersmeetup2buildingapiwithapiaryhandsonworksheet/BoopathyBalasubraman/oracle-apacdevelopersmeetup2buildingapiwithapiaryhandsonworksheet
Meetup Site:
https://www.meetup.com/Oracle-Developers-APAC/events/248288651/
Angular 6 Training with project in hyderabad indiaphp2ranjan
ngularJS is one of the JavaScript open-source web application frameworks which is generally used to add an HTML page along with a tag. The major aim of AngularJS is to simplify the application development and testing performance by providing a framework called MVC (Model View Controller) Architecture. It enables the application to change from bulk amount of programming code into a simple code.
Understanding and Executing on API Developer ExperienceSmartBear
What is Developer Experience, and how can you leverage it to drive adoption and growth for your API? Our very own Keshav Vasudevan will take you through it. Learn more: https://blog.smartbear.com/apis/developer-experience-the-key-to-a-successful-api/
API Developer Experience: Why it Matters, and How Documenting Your API with S...SmartBear
Whether you’re new to Swagger, or have already been using the framework for API design, there’s a good chance you still have questions about how to improve your API documentation. Creating API documentation your consumers will love can take some work, but the investment will have a significant payoff in the form of a great developer experience, easier implementation, and improved adoption of your API.
This presentation covers good developer experience in detail, focusing on why and how to provide an optimal experience for developers using your API. We will also cover how Swagger has changed the API design and documentation landscape, and finally show some good practices for API documentation using Swagger in SwaggerHub’s integrated API development platform.
Things to expect in this webinar:
What is Developer Experience (DX)?
What does it mean for an API to have good DX?
API documentation in the context of good DX?
An introduction to the Swagger framework
Designing APIs from a usability perspective using Swagger and SwaggerHub
What is developer experience? And how can it affect the success of your product? Our very own Keshav Vasudevan will take you through everything you need to know.
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...apidays
INTERFACE, by apidays 2021 - It’s APIs all the way down
June 30, July 1 & 2, 2021
The 8 Key Components of a Modern API Stack
Iddo Gino, CEO at RapidAPI
Content Strategy and Developer Engagement for DevPortalsAxway
Slides from Write the Docs Ottawa Meet Up at Shopify HQ in Canada, June 24, 2019
We’ll walk through 5 scenarios and concrete ways of reaching a developer community for frictionless and increased engagement.
A One Stop Solution Platform for various Services Helping Tools.pptxSHIVAMGIRI35
Presentation on web application project named helping.tools
research paper published in the IJRASET journal. "A One Stop Solution Platform for various Services: Helping Tools" and it was authored by Chaitanya Shimpi, Shivam Giri, Saifali Awati, Rucha Bhosale, and Prof. Vidya Waykule.
Designing API Platforms that Developers Love - New York Life Build Blue May 2017Deepak Nadig
Consumers today are increasingly using a variety of applications across web, mobile, cars and devices to find information and/or to perform their tasks. In addition, Consumers are also using multiple modes of interactions - including touch and voice - with these applications. To deliver these variety of applications and natural interaction paradigms, companies need to develop API and service platforms that can be used by their internal developers as well as external developers and partners. In order to survive and be competitive, companies need to move quickly to deliver such platforms and features. It's Not the Big that Eat the Small... It's the FAST that Eat the Slow!
Successful platforms, from companies such as eBay, PayPal, Amazon and Intuit, embody attributes such as delightful integration experience, flexibility and extensibility along with implicit developer expectations - security, quality, response time and availability.
This talk will share a recipe for building and delivering platforms that developers love - principles, best practices and approaches - across architecture, organizational and cultural - used in companies such as eBay, PayPal and Intuit.
Best Practices for API Adoption - WIP Factory presentation for AnyPresence we...Carlo Longino
The document discusses best practices for API adoption and onboarding developers. It recommends focusing onboarding efforts on the right developers by understanding their needs and expectations. The onboarding process should make it easy for developers to get started through quick registration, documentation, examples and getting developers to their first "Hello World" quickly to minimize friction. Libraries, SDKs and other tools can help light the path for developers. Managing expectations and understanding different types of developers is also important for effective onboarding.
Elevating Developer Experiences with AI-Powered API Testing & DocumentationPostman
In the modern era, APIs have exploded in their popularity, powering absolutely everything we interact with on a daily basis (whether we know it or not). Maintaining their coherence and functionality has become, to say the least, a difficult task for developers and engineering leaders. As the API landscape continues to grow increasingly complex, the absence of robust testing and comprehensive documentation can lead to a cascade of issues, resulting in downstream pain for both developers and end-users alike.
However, there is a silver lining on the horizon: harnessing the power of AI to help write API tests and documentation, ensuring seamless integration, improved developer experiences, and ultimately, greater efficiency in API-driven development workflows. Join us as we delve into the transformative potential of AI in shaping the future of API testing and documentation, paving the way for a more streamlined and effective development ecosystem.
Architecting Developer Experience: Fintech and Banking Devportal Case StudiesPronovix
This document discusses best practices for architecting developer experience (DX) through developer portals. It outlines the developer journey in 6 stages: discover/research, evaluate, get started, develop & troubleshoot, celebrate, and maintain. For each stage, it provides examples of how banking and fintech portals can support developers through features like API catalogs, documentation, tutorials, support options, feedback mechanisms, and release notes. The goal is to reduce API friction and engage developers at each stage of use to improve overall experience.
Architecting DX: Banking & FinTech Developer Portals Case Studies (APIDays Pa...Kathleen De Roo
To provide great DX, we need to tackle API friction (the resistance developers experience while using your API) along the developer journey stages and apply developer marketing techniques. The success of a developer portal is very much influenced by how users feel along their journey and afterwards. Do your resources match their needs and expectations to reach a specific goal? How can you make sure users can onboard easily? Which documentation types match the journey stages best and provide the best documentation experience? How can you make sure you don’t constrain users? How can you engage developers, even turn them into your advocates?
This talk focuses on public-facing (external) banking and fintech developer portals and show many examples of the current best practices and patterns, spiced up with in-house research results
APIdays Paris - Architecting Developer eXperience: Banking & FinTech Develope...apidays
Architecting Developer eXperience: Banking & FinTech Developer Portals Case Studies
Kathleen De Roo, Information Architect & Tech Writer, Pronovix
Apply to be a speaker here - https://apidays.typeform.com/to/J1snsg
apidays LIVE Hong Kong - Why you need a DevRel team for your API by Anna Tsol...apidays
apidays LIVE Hong Kong - The Open API Economy: Finance-as-a-Service & API Ecosystems
Why you need a DevRel team for your API
Anna Tsolakou, Developer Advocate at Amadeus
Why you need a Developer Relations team for your APIPronovix
Providing a good API product to your users is the minimum. With all the competition developers have many more expectations than quality APIs; developer community, documentation, tutorials, developer tools and this is exactly where the Developer Relations (DevRel) team fits. In this talk we’ll discuss why your API product needs a DevRel team and how it can drastically upgrade the face of your API program and satisfy your users. We’ll talk about how the DevRel team can engage your users to nurture a long-term community and make your API product successful.
Transforming enterprise it with containers, ap is and integration api manage...Judy Breedlove
These slides are from a recent Red Hat event featuring Steve Willmott, senior director and head of API infrastructure at Red Hat.
Overview: Enterprise IT needs are evolving at breakneck speed and are becoming critical to business success. Organizations now face the need to deliver and evolve their software infrastructure more quickly and effectively than ever before. At this event, we'll cover the tools and techniques used by Red Hat's most successful clients. In particular, we'll focus on how application programming interfaces (APIs), combined with containers and integration, create highly effective software systems.
We will also discuss how APIs can be used to transform the internal IT landscape, how they combine with containers for effective microservices strategies, and how they fit with integration technologies. The material will cover architecture, technology, and lessons from the field with customer examples.
Make Your Contribution Count. Adding Value to the API as a Technical Communic...Petko Mikhailov
Even though documenting APIs is a highly technical proposition, the contribution that a technical communicator can make to the documentation is not the same as that of the writing developer. In fact, API documentation is the place where we can shine and make the difference between failure and success of a product on the market.
In this presentation, we'll see what makes good API documentation and how API writers can bring unique value to it.
Presented at the tekom Spring Conference 2019 (Vienna).
Developer marketing is an important asset for creating alignment between important online assets such as SaaS products, API portals and human (programmer) capital management.
Using a Developer marketing approach will create more successful (API) products and longer term commitment from external and internal developers to your code, SaaS and API base.
Flipping the script: How to take the first step towards internal developer pl...Abigail Bangser
This is a talk about why you should be investing in the API for your internal platform and how you can get started with the existing user experiences in your org to drive the adoption of the new API.
Main news related to the CCS TSI 2023 (2023/1695)Jakub Marek
An English 🇬🇧 translation of a presentation to the speech I gave about the main changes brought by CCS TSI 2023 at the biggest Czech conference on Communications and signalling systems on Railways, which was held in Clarion Hotel Olomouc from 7th to 9th November 2023 (konferenceszt.cz). Attended by around 500 participants and 200 on-line followers.
The original Czech 🇨🇿 version of the presentation can be found here: https://www.slideshare.net/slideshow/hlavni-novinky-souvisejici-s-ccs-tsi-2023-2023-1695/269688092 .
The videorecording (in Czech) from the presentation is available here: https://youtu.be/WzjJWm4IyPk?si=SImb06tuXGb30BEH .
LF Energy Webinar: Carbon Data Specifications: Mechanisms to Improve Data Acc...DanBrown980551
This LF Energy webinar took place June 20, 2024. It featured:
-Alex Thornton, LF Energy
-Hallie Cramer, Google
-Daniel Roesler, UtilityAPI
-Henry Richardson, WattTime
In response to the urgency and scale required to effectively address climate change, open source solutions offer significant potential for driving innovation and progress. Currently, there is a growing demand for standardization and interoperability in energy data and modeling. Open source standards and specifications within the energy sector can also alleviate challenges associated with data fragmentation, transparency, and accessibility. At the same time, it is crucial to consider privacy and security concerns throughout the development of open source platforms.
This webinar will delve into the motivations behind establishing LF Energy’s Carbon Data Specification Consortium. It will provide an overview of the draft specifications and the ongoing progress made by the respective working groups.
Three primary specifications will be discussed:
-Discovery and client registration, emphasizing transparent processes and secure and private access
-Customer data, centering around customer tariffs, bills, energy usage, and full consumption disclosure
-Power systems data, focusing on grid data, inclusive of transmission and distribution networks, generation, intergrid power flows, and market settlement data
Connector Corner: Seamlessly power UiPath Apps, GenAI with prebuilt connectorsDianaGray10
Join us to learn how UiPath Apps can directly and easily interact with prebuilt connectors via Integration Service--including Salesforce, ServiceNow, Open GenAI, and more.
The best part is you can achieve this without building a custom workflow! Say goodbye to the hassle of using separate automations to call APIs. By seamlessly integrating within App Studio, you can now easily streamline your workflow, while gaining direct access to our Connector Catalog of popular applications.
We’ll discuss and demo the benefits of UiPath Apps and connectors including:
Creating a compelling user experience for any software, without the limitations of APIs.
Accelerating the app creation process, saving time and effort
Enjoying high-performance CRUD (create, read, update, delete) operations, for
seamless data management.
Speakers:
Russell Alfeche, Technology Leader, RPA at qBotic and UiPath MVP
Charlie Greenberg, host
"Choosing proper type of scaling", Olena SyrotaFwdays
Imagine an IoT processing system that is already quite mature and production-ready and for which client coverage is growing and scaling and performance aspects are life and death questions. The system has Redis, MongoDB, and stream processing based on ksqldb. In this talk, firstly, we will analyze scaling approaches and then select the proper ones for our system.
zkStudyClub - LatticeFold: A Lattice-based Folding Scheme and its Application...Alex Pruden
Folding is a recent technique for building efficient recursive SNARKs. Several elegant folding protocols have been proposed, such as Nova, Supernova, Hypernova, Protostar, and others. However, all of them rely on an additively homomorphic commitment scheme based on discrete log, and are therefore not post-quantum secure. In this work we present LatticeFold, the first lattice-based folding protocol based on the Module SIS problem. This folding protocol naturally leads to an efficient recursive lattice-based SNARK and an efficient PCD scheme. LatticeFold supports folding low-degree relations, such as R1CS, as well as high-degree relations, such as CCS. The key challenge is to construct a secure folding protocol that works with the Ajtai commitment scheme. The difficulty, is ensuring that extracted witnesses are low norm through many rounds of folding. We present a novel technique using the sumcheck protocol to ensure that extracted witnesses are always low norm no matter how many rounds of folding are used. Our evaluation of the final proof system suggests that it is as performant as Hypernova, while providing post-quantum security.
Paper Link: https://eprint.iacr.org/2024/257
Northern Engraving | Modern Metal Trim, Nameplates and Appliance PanelsNorthern Engraving
What began over 115 years ago as a supplier of precision gauges to the automotive industry has evolved into being an industry leader in the manufacture of product branding, automotive cockpit trim and decorative appliance trim. Value-added services include in-house Design, Engineering, Program Management, Test Lab and Tool Shops.
Introduction of Cybersecurity with OSS at Code Europe 2024Hiroshi SHIBATA
I develop the Ruby programming language, RubyGems, and Bundler, which are package managers for Ruby. Today, I will introduce how to enhance the security of your application using open-source software (OSS) examples from Ruby and RubyGems.
The first topic is CVE (Common Vulnerabilities and Exposures). I have published CVEs many times. But what exactly is a CVE? I'll provide a basic understanding of CVEs and explain how to detect and handle vulnerabilities in OSS.
Next, let's discuss package managers. Package managers play a critical role in the OSS ecosystem. I'll explain how to manage library dependencies in your application.
I'll share insights into how the Ruby and RubyGems core team works to keep our ecosystem safe. By the end of this talk, you'll have a better understanding of how to safeguard your code.
Freshworks Rethinks NoSQL for Rapid Scaling & Cost-EfficiencyScyllaDB
Freshworks creates AI-boosted business software that helps employees work more efficiently and effectively. Managing data across multiple RDBMS and NoSQL databases was already a challenge at their current scale. To prepare for 10X growth, they knew it was time to rethink their database strategy. Learn how they architected a solution that would simplify scaling while keeping costs under control.
"Scaling RAG Applications to serve millions of users", Kevin GoedeckeFwdays
How we managed to grow and scale a RAG application from zero to thousands of users in 7 months. Lessons from technical challenges around managing high load for LLMs, RAGs and Vector databases.
The Microsoft 365 Migration Tutorial For Beginner.pptxoperationspcvita
This presentation will help you understand the power of Microsoft 365. However, we have mentioned every productivity app included in Office 365. Additionally, we have suggested the migration situation related to Office 365 and how we can help you.
You can also read: https://www.systoolsgroup.com/updates/office-365-tenant-to-tenant-migration-step-by-step-complete-guide/
Must Know Postgres Extension for DBA and Developer during MigrationMydbops
Mydbops Opensource Database Meetup 16
Topic: Must-Know PostgreSQL Extensions for Developers and DBAs During Migration
Speaker: Deepak Mahto, Founder of DataCloudGaze Consulting
Date & Time: 8th June | 10 AM - 1 PM IST
Venue: Bangalore International Centre, Bangalore
Abstract: Discover how PostgreSQL extensions can be your secret weapon! This talk explores how key extensions enhance database capabilities and streamline the migration process for users moving from other relational databases like Oracle.
Key Takeaways:
* Learn about crucial extensions like oracle_fdw, pgtt, and pg_audit that ease migration complexities.
* Gain valuable strategies for implementing these extensions in PostgreSQL to achieve license freedom.
* Discover how these key extensions can empower both developers and DBAs during the migration process.
* Don't miss this chance to gain practical knowledge from an industry expert and stay updated on the latest open-source database trends.
Mydbops Managed Services specializes in taking the pain out of database management while optimizing performance. Since 2015, we have been providing top-notch support and assistance for the top three open-source databases: MySQL, MongoDB, and PostgreSQL.
Our team offers a wide range of services, including assistance, support, consulting, 24/7 operations, and expertise in all relevant technologies. We help organizations improve their database's performance, scalability, efficiency, and availability.
Contact us: info@mydbops.com
Visit: https://www.mydbops.com/
Follow us on LinkedIn: https://in.linkedin.com/company/mydbops
For more details and updates, please follow up the below links.
Meetup Page : https://www.meetup.com/mydbops-databa...
Twitter: https://twitter.com/mydbopsofficial
Blogs: https://www.mydbops.com/blog/
Facebook(Meta): https://www.facebook.com/mydbops/
Dandelion Hashtable: beyond billion requests per second on a commodity serverAntonios Katsarakis
This slide deck presents DLHT, a concurrent in-memory hashtable. Despite efforts to optimize hashtables, that go as far as sacrificing core functionality, state-of-the-art designs still incur multiple memory accesses per request and block request processing in three cases. First, most hashtables block while waiting for data to be retrieved from memory. Second, open-addressing designs, which represent the current state-of-the-art, either cannot free index slots on deletes or must block all requests to do so. Third, index resizes block every request until all objects are copied to the new index. Defying folklore wisdom, DLHT forgoes open-addressing and adopts a fully-featured and memory-aware closed-addressing design based on bounded cache-line-chaining. This design offers lock-free index operations and deletes that free slots instantly, (2) completes most requests with a single memory access, (3) utilizes software prefetching to hide memory latencies, and (4) employs a novel non-blocking and parallel resizing. In a commodity server and a memory-resident workload, DLHT surpasses 1.6B requests per second and provides 3.5x (12x) the throughput of the state-of-the-art closed-addressing (open-addressing) resizable hashtable on Gets (Deletes).
5th LF Energy Power Grid Model Meet-up SlidesDanBrown980551
5th Power Grid Model Meet-up
It is with great pleasure that we extend to you an invitation to the 5th Power Grid Model Meet-up, scheduled for 6th June 2024. This event will adopt a hybrid format, allowing participants to join us either through an online Mircosoft Teams session or in person at TU/e located at Den Dolech 2, Eindhoven, Netherlands. The meet-up will be hosted by Eindhoven University of Technology (TU/e), a research university specializing in engineering science & technology.
Power Grid Model
The global energy transition is placing new and unprecedented demands on Distribution System Operators (DSOs). Alongside upgrades to grid capacity, processes such as digitization, capacity optimization, and congestion management are becoming vital for delivering reliable services.
Power Grid Model is an open source project from Linux Foundation Energy and provides a calculation engine that is increasingly essential for DSOs. It offers a standards-based foundation enabling real-time power systems analysis, simulations of electrical power grids, and sophisticated what-if analysis. In addition, it enables in-depth studies and analysis of the electrical power grid’s behavior and performance. This comprehensive model incorporates essential factors such as power generation capacity, electrical losses, voltage levels, power flows, and system stability.
Power Grid Model is currently being applied in a wide variety of use cases, including grid planning, expansion, reliability, and congestion studies. It can also help in analyzing the impact of renewable energy integration, assessing the effects of disturbances or faults, and developing strategies for grid control and optimization.
What to expect
For the upcoming meetup we are organizing, we have an exciting lineup of activities planned:
-Insightful presentations covering two practical applications of the Power Grid Model.
-An update on the latest advancements in Power Grid -Model technology during the first and second quarters of 2024.
-An interactive brainstorming session to discuss and propose new feature requests.
-An opportunity to connect with fellow Power Grid Model enthusiasts and users.
Fueling AI with Great Data with Airbyte WebinarZilliz
This talk will focus on how to collect data from a variety of sources, leveraging this data for RAG and other GenAI use cases, and finally charting your course to productionalization.
Essentials of Automations: Exploring Attributes & Automation ParametersSafe Software
Building automations in FME Flow can save time, money, and help businesses scale by eliminating data silos and providing data to stakeholders in real-time. One essential component to orchestrating complex automations is the use of attributes & automation parameters (both formerly known as “keys”). In fact, it’s unlikely you’ll ever build an Automation without using these components, but what exactly are they?
Attributes & automation parameters enable the automation author to pass data values from one automation component to the next. During this webinar, our FME Flow Specialists will cover leveraging the three types of these output attributes & parameters in FME Flow: Event, Custom, and Automation. As a bonus, they’ll also be making use of the Split-Merge Block functionality.
You’ll leave this webinar with a better understanding of how to maximize the potential of automations by making use of attributes & automation parameters, with the ultimate goal of setting your enterprise integration workflows up on autopilot.
6. 6@keshinpoint
The Multi Platform Ecosystem
A platform is a
product that can be
extended by users for
the benefit of others
Average consumer
Third party developer
7. 7@keshinpoint
Developers Are Humans Too
DX is the aggregate of all the experiences a developer has
when interacting with your Platform, usually through an API
9. 9@keshinpoint
Why DX Matters
Prevents Switch: Makes APIs differentiable and competitive
Growth and Adoption: The value of an API increases
when users reach critical mass
Helps drive business and technological goals
10. 10@keshinpoint
Speaking of Business and Technological Goals
Public APIs
Priority: High Adoption
Private APIs
Priority: Low Cost
Partner APIs
Priority: High Adoption, Low Cost
11. 11
How To Think About DX
SmartBear Proprietary & Confidential
13. 13@keshinpoint
Three Step Process for Good DX
Step 1
Understand the API’s
audience
Step 2
Understand the
audience journey
Step 3
Map the audience to
the journey
14. 14@keshinpoint
Step 1: Understand the API’s Audience
API Users
Newcomer -
First Time
User
Debugger –
addressing a
specific issue
Evaluator-
Deciding whether
to use the API
Problem Solver –
Is X possible
with this API
API Decision
Makers
Eg: CTO Eg: PM
16. 16@keshinpoint
Step 3: Map Journey to the Right Audience
Why should I use
it?
How do I register? Where do I start? How do I use it?
Focus: Decision
Makers
Focus: Decision
Makers, API Users
Focus: Decision
Makers, API Users
Focus: API Users
Product Marketing Design and
Documentation
18. 18@keshinpoint
Follow the 3:30:3 Rule
3:30:3 Rule
•3 seconds to understand API’s purpose
•30 seconds to identify entry point into system
•3 minutes to use the API’s result
19. 19@keshinpoint
3.a. “Why Should I Use It”?
Focus: Decision
Makers
Why should I use
it?
Position based on
Industry
Concise messaging of
core value
Understand value in 3
seconds
Recommendations
22. 22@keshinpoint
3.b. “How Should I Register?”
How do I register? Focus: Decision Makers, API
Users
Explain setup in
comprehensive fashion
Recommendations
Minimal steps to
register – 30 seconds
Provide API console
23. 23@keshinpoint
Examples
Make Sign up straightforward
Dropbox asks you for your name, email and password for the free API key. It also allows Google sign in.
Straightforward process with Mailchimp as well.
24. 24@keshinpoint
Bad Examples
Jumping through
hurdles -
SoundCloud
SoundCloud asks users to fill up
a 3 page Google form, with
details on the app idea, before
awarding the API key. Waiting
period is typically 2 weeks
25. 25@keshinpoint
3.c. “Where and How Do I Use it?”
Where do I
start?
How do I use
it?
Documentation
Focus: API Users
Focus: Decision
Makers, API Users
27. 27@keshinpoint
What is API Documentation
•Documentation is a deliverable of technical content, containing
instructions on how to effectively use your API –> usage manual
•Good documentation can be a determining factor is API adoption
and growth
An API is only as good as its documentation
32. 32@keshinpoint
OpenAPI Specification is the Answer
Allow machines/tools to integrate with API
Allow humans to implement API code
Allow humans to read and generate API documentation
and test cases
33. 33@keshinpoint
The OpenAPI Spec is the API Contract
•The OAS is an API description format to Design and Document
REST APIs
•The OAS defines your API’s contract
•Connects computers, technology stacks and humans in one
unified language
34. 34@keshinpoint
Evolution of the OAS
•2010 – Wordnik created and open sourced Swagger Specification
•2010 to 2015 – Massive adoption of the Swagger Specification,
with Swagger tooling developed by community
•2015 - Swagger Spec and core tooling acquired by SmartBear
•2015 – Open API Initiative was
create to standardize REST design.
Swagger Spec was renamed as
OAS
38. 38@keshinpoint
Effective Documentation Tips
•Documentation plays a central role in the way APIs are perceived
by a User
•Tip 1: List the Fundamentals
•Tip 2: Write for Humans
•Tip 3: Explain your Request-Response Cycles
•Tip 4: Empower with Experimentation
39. 39@keshinpoint
Tip 1: List the Fundamentals
Fundamental sections in every documentation
Authentication Errors End Points
Terms of Use ChangelogExamples
44. 44@keshinpoint
Tip 2: Write for Humans
Never Assume
Audience is 100% developers Consumers are fully familiar with
API/Domain Jargon
• Strive to make documentation readable by Decision Makers
• Start writing in plain English without jargon
• Provide context and information for jargon and domain specific
words
• Maintain consistency of tone
46. 46@keshinpoint
Tip 3: Explain your Request-Response Cycles
•Your API Users should know exactly what to expect from a
successful call
•Describe full sample response body in every supported format
•Focus not just on the response format, but also HTTP response
headers and error codes
•Provide enough context using examples
1. Examples in Use Cases
2. Examples in Request-Response Cycles
49. 49@keshinpoint
Tip 4: Experimentation is Power
The difference between documentation and good
documentation is a little more effort with these Nice-to-
haves.
Allow developers to experiment with your API
1. Getting Started Guides
2. Interactive Docs and Console
3. SDKs
4. Tutorials
52. 52@keshinpoint
Summary
•Good API Developer Experience can help drive business and
tech goals
•Three step framework for understanding API DX
–Understand audience
–Understand journey
–Map journey to audience
• Tips for Good API Documentation
–List the Fundamentals
–Write for Humans
–Explain your Request-Response Cycles
–Empower with Experimentation
APIs, in a nutshell, allow different products and services to talk to each other.
The API revolution can be seen in the number of public APIs that exist right now. It’s estimated that we have about 20,000 public APIs, not counting the partner APIs, or the millions that exist as private APIs. This number is from looking at the number of public APIs in the programmable web directory, as well as the predictions made by getElastic. This number is said to be lower than what is actually out there, and different sources report differently. APIhound for example, estimates there are 50,000 public web APIs.
This number is only set to increase with the exponential rise in the number of connected devices. The IOT revolution is upon us, with home devices, bots, VR and AR, all contributing to our growing desire to stay connected. By 2020, it is estimated that every person in the world will have, on average, 7 devices. The IoT market is predicted to grow to 1.7 trillion by 2020.
This is further proof why organizations should start thinking about their API strategy, since APIs are the best way to penetrate across all these devices as a data rich channel.
We’re in the multi platform economy, and APIs are the digital glue that holds them together. What do I mean by platforms? Well, lets take an example of Facebook, or fitbit-
Facebook was started in 2004, and enabled people to make social connections and interact online. It was a product on the WWW and 3 years later, FB launched their API, to give an unprecedented amount of access to developers. , transforming FB from a product into a platform.
A platform is a product that can be extended by a user for the benefit of other users. Any product can become a platform by providing methods for users to add services and functionalities on top of it, and APIs has enabled products to become platforms more easily by connecting them together with APIs.
When a product transitions into being a platform, it takes on a new type of user: the third-party developer. But they are a special type of user, one that behaves as an intermediary between end users and the platform product.
As such, it is incredibly important to cater to the experience of the developer consuming your APIs, espeiclaly given APIs are actually driving business and technological goals.
Developer Experience is an extension of UX that focuses on the experience of the developer integrating and consuming your Platform
Ronnie Mitra, a prominent spokesperson for developer experience, says that if an API has bad DX, and developers aren’t required to use it, you can bet they won’t.”
And of course, the upside to having good developer experience, is that there’ll be an increase in adoption of your APIs, which would lead to innovative ways for your end developers to improve on your platform’s functionality.
There will be more people talking about it, making your services credible and authentic, which would drive towards increased growth of your products and higher demand for your services.
Usability does not triumph Utility
A good developer experience should strive for three goals
Good DX will help solve a consumer need, or alleviate some of the pain points in their existing processes
It helps the business – as I mentioned in the previous slides, good DX leads to better adoption, and more users adds more value to the services distributed via the API for the business
Finally, an API that has a DX oriented focus can last longer, as more users will have dependencies associated with the API
There is a three step framework I would recommend applying to craft an optimal experience for users consuming an API. The first step is to understand the Api’s audience intimately – their personas, charecteristics, and what they’re trying to achieve or accomplish. From here, you have to learn their journey from API discovery to consumption, and the various steps between them
Finally, you map the right audience to the different phases in their journey, and optimize the experience. Lets walk through this
As with any product — and yes, APIs are products, the documentation is a usage manual for effectively consuming your API — we need to start by understanding who needs to use the content you produce. The most common form of consumers for your API’ documentation, are the people who need to directly integrate and work with your API, and the people who want to evaluate whether your API will fit into their development cycle and business strategy.
They are-
Engineers looking to get started — newcomer
Developer solving a specific issue in an existing client — the debugger
CTO evaluating competing APIs — the Evaluator
Product manager figuring out if X is possible with the API — problem Solver
1: Information Architecture
When designing site-wide information architecture, it is important to note the priority of what information the site visitor needs to know. One must consider what information developers immediately desire to see, and what resources visitors with varying levels of experience will require.
Providing detailed documentation is a must for a technical audience, and your non-technical audience will require information on licensing agreements, an often underprivileged aspect. Your structure should accordingly group relevant information into categories that are easily understandable and easy to find. It’s a good idea to order sections from the broad to specific, making sure that you have clear paths to the information, and a good search by keyword or topic option available.
As an example, take the MailChimp API portal. It prioritizes highly pertinent information with a reminder of v3.0 version release and deprecation notice. It also does a good job of structuring information in order of beginner to advance, ordering sections from Getting started —> How-Tos—> Downloads and API wrappers —> Actual API Documentation. Links that may be irrelevant to a bulk of site visitors, like Partner APIs, or MailChimp’s Mandrill service, are still included yet listed toward the bottom in accordance with priority.
http://nordicapis.com/beautiful-ui-design-for-api-developer-portals/
Mention how designers and documentation writers should partner with marketing
Once you’ve identified your audience, and their journey to using your API, it’s time to map what the main focus would be across each phase of this journey. This focus doesn’t mean you should ignore the other type of users, it only means you need to make sure that at a bare minimum, that this specific type of audience is catered to.
In the first stages we should, at a minimum, focus on the Decision Makers like the CTOs and PMs. The next two stages – which is “How do I register” and ‘Where do I start”, should cater to your API users as well as your Decision Makers. The remaining stages should have a strong focus on your API users, meaning these people should be able to have a great experience registering, understanding, integrating and consuiming your services.
These phases are also functions of different job types. For example, the first two stages is more of a Product marketing exercise, with effective messaging of your platform’s values. The next stages is a documentation and technical writing exercise, with rich content for a technical user base that enables them to understand how to use your API.
http://nordicapis.com/5-reasons-why-developers-are-not-using-your-api/
Ori Pekelman, a regular speaker at API events, created a rule that summarizes the best possible engagement between developers and your API. The 3:30:3 rule states that on the homepage of your API a developer should:
Be able to create an account, call and Understand in 3 seconds the purpose of your API.
Be able to identify the entry point in 30 seconds the system, and use the result in under 3 minutes
To be able to follow this rule you should treat your API as a product where developers are your target customers. Every piece of content you put out, be it on the homepage or in the documentation, should try to help your end users obtain the most value in the minimum amount of time possible.
Let’s start with the first phase of the Developer Journey – the Why should I use it aspect. This aims to provide your audience a high level message abd overview of your services in a way that immedietly resonates with the tasks they want to accomplish. Focus on the homepage itself and what message it conveys to visitors. Developers should quickly understand the main feature your API is offering and how they can start using it.
This is where the human interacts with the information presented before them for the first time. Since this is a product marketing exercise, the writer must jump into the psychology of the user, considering that upon visiting a site for the first time, a user needs to know what I can do with this API and why I should use this API.
http://nordicapis.com/beautiful-ui-design-for-api-developer-portals/
Decision makers and Users, both want to try your API
First step is to obtain an API key
After the audience understands your value and what it would mean for their, their next step would be to register with your system in order to try and start using your API. The registration process should be as straightforward as possible, but you should be able to obtain all the information you need during this phase. A good strategy is to let developers sign up using a popular third-party service like Twitter and GitHub. You need to be able to quickly capture your user’s name and email address, without making them go through too many hurdles.
http://nordicapis.com/5-reasons-why-developers-are-not-using-your-api/
Documentation should quickly take developers to a stage where they’re already using the API with little or no effort.
One possible way to make this happen is to create a “sandbox environment,” where developers can play with the API without actually hitting your production servers. This allows you to offer a minimum signup process, asking only what is really needed instead of a lengthy registration process that can drive many developers away.
Good documentation should clearly inform developers of what they must do to get started — and how to do it. If your API works with API tokens, generate one on-the-fly and let developers use it right away. If you use OAuth, provide fake consumer information, and even an access token, so developers can start making API calls immediately.
Remember that this is only the first step of engagement, and developers are still evaluating your API. You should let them experiment as much as possible, but without compromising your production systems or any real user information.
http://nordicapis.com/spark-api-adoption-good-documentation-practises/
So we finally come to the last stages of your developer journey. Your audience understood your services value proposition, it ignited their interest, and they went on to register. Now is the time they would want to get their hands dirty with your API, trying it out and eventually integrating it with their own apps. How do you guide them through this journey? Documentation.
API documentation, also known as Programmers documentation, is a deliverable of technical writing with good instructions about how to effectively use it. If you get your documentation right, more people will find value in your services easily, leading to better growth and adoption. Remember, your API is only as good as your documentation
As a good start, having clear and up to date documentation is a great way for your users to understand how to use your API. Users are going to spend a fair amount of time reading the documentation, therefore it should be considered part of the product.
And of course, having great documentation has a direct correlation to adoption and growth .
The OAS is an API description format to design and document REST APIs. It can be written in YAML or JSON, and involves no code. It’s pure human and machine readable, and just designs what the API does and how it’s supposed to behave
To use the toolkit, you start by modeling your API with the Swagger(openAPI) specification, written in YAML or JSON.
Example contract – describe metadata, resources, operations.
Towards the end, say “keeps them all aligned and in sync”
In the context of this webinar, one of Swagger’s biggest strengths is the ability to generate interactive documentation straight from your API’s contract.
So let’s dive into this phase a little more. Let’s understand API documentation better.
Among all the API-related phases, documentation is probably the area showing the most growth. This is especially true with the tooling ecosystem around documentation. It’s interesting to note this trends, since documentation is traditionally something that developers pay little attention to when launching code.
API Documentation, as mentiponed before, is the technical writing to understand how to use your API, and is crucial to take the user to success in the last 2 stages of their journey – How do I get started, and use the API
These are the sections that every API documentation should offer. Without these sections consumers will have a very hard time understanding how your API can be used, and, in many cases, they could even stop using your services.
Authentication information about authentication schemes your API uses.
information, describing which authentication scheme your API uses. If you’re using OAuth, don’t forget to explain how to setup an OAuth application and obtain the API Key and Secret.
Errors and how they’re communicated to API consumers. Exlain the error standards, and also provide solutions on how to overcome them.
Endpoints and information on how to consume them, including requests and responses. This is considered the main section where you expose all your API methods, explain how they can be reached, and note what kind of parameters are allowed.
Examples of how to consume your API, including starting from scratch but also displaying use cases where your API would come in handy. Include plenty of code and, if possible, case studies with actual API consumers and example applications.
Terms of Use, including API Limits and other best practice terms and conditions. Constraints need to be clearly stated so that consumers understand what API usage and practices are permitted
A Changelog detailing latest updates and how they might affect API consumers. This will help consumers know the stability of the API and see if any changes made to the API calls might impact their application.
With these sections you’re off to a great start because you’ve already documented most of what is needed to consume your API and your offering. But, as you’re about to find out, this is often not enough. As you obtain more sophisticated consumers, you’ll end up having to offer them documentation on non-functional aspects of your API.
http://nordicapis.com/using-templates-for-documentation-driven-api-design/
Most API docs just assume their audience is 100% developers, and further (incorrectly) that those developers are completely familiar with the API’s domain and jargon.
Instead, you should strive to make the documentation for every call intelligible first to the people searching (evaluators) , who are trying to understand which call does what to which nouns and why. I would recommend that you actually start your documentation process by writing these English domain explanations for each call. It is also a great practice to link jargon and domain-specific words to useful definitions the first time they are used in any given section.
These tactics will help you ensure clarity and good structure across your API at the level of the domain and why certain calls exist, before you ever get lost in the details of parameters, headers and responses.
Consider your overall tone — Your documentation should have a consistent tone, in tune with whatever branding strategy your company has adopted. Try to reflect this tone across every aspect of your documentation to help speed up the learning process
https://bradfults.com/the-best-api-documentation-b9e46400379a#.eroijicnl
Do not leave anything to the imagination with your request and response cycles. Your end users should know exactly what to expect when using any end point.
Think of not only the format, like XML or JSON, but also of the HTTP headers, error codes and messages. Put yourself in the end user’s shoes, and understand that too much information when integrating with your services is never a bad option. Describe the entire parameter and response body
You should also, in the start itself, describe all the possible error codes. I’ll show you an example of how Stripe handles this in the next slide.
When naming parameters, use terminology that users will understand. As always, provide examples of the type of parameters, a description and any other information you believe could help your end consumer
A little more effort goes a long way in actually enabling developers to actually reach success with your API in their software programs. There are some good nice to haves, listed here. The key takeaway is to have a great way for your consumers to get on-boarded and use your API.
Start with a getting started guide. It’s a great start from API newcomers, and helps them quickly understand what your API can do. Remember the 3 minute rule, so try to create a getting started guide that helps them obtain an end result in 3 minutes or less.
Interactivity in your API documentation is a great way to let developers test your API, without actually integrating it in their application. The sandbox or console should be easy to deploy and reset whenever needed.
The more SDKs, the better. SDKs aren’t always the best go-to market strategy, but once your API is out, it’s a great idea to invest in building client libraries that allow devs to effectively use your API. If a lot of developers are finding value in your services easily and effectively, they might even build SDKs for you. It’s all about dev relations, and focusing on their experience using good documentation is a step towards achieving this.
Publish tutorials: Provide sample snippets using the SDKs in as many languages as possible, with example use cases and tutorials to achieving different results
Offer an API console: This is the minimum you should offer as an experimentation tool. With an API console, developers are encouraged to immediately test what they see in the documentation, and see real API calls taking place.
This interactivity is not just helpful for the API consumer, but it’s aslo great for the person doing the documentation
http://nordicapis.com/spark-api-adoption-good-documentation-practises/
A good option to provide a sandbox is to use some type of virtualization that lets your system quickly deploy a server that is ready to use by developers. There are several available options with varying levels of complexity:
Using Vagrant with an image containing your API server and a fake data set. Vagrant quickly launches a VirtualBox machine that can easily be shut down and relaunched.
Using Vagrant with a cloud hosting provider such as DigitalOcean. This option will make it even easier because you don’t have to deal with the servers yourself. There’s a great tutorial explaining how to get this setup and running.
Using Docker to quickly launch a new API environment that developers can access. A way to do this is to use Fig which lets you launch an isolated environment using Docker.
http://nordicapis.com/5-reasons-why-developers-are-not-using-your-api/