Specification-driven API Design vs Technical Writers

•

1 like•722 views

This talk, originally given at tcworld18, shows the importance of API Design and documentation for developer experience (DX), introduces OpenAPI and then explains how a spec-driven API lifecycle can help with DX, highlighting the role of technical writers.

Software

Specification-driven API Design
vs.
Technical Writers
Lukas Rosenstock
tcworld18, 15th Nov 2018

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers

“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
API
abbr. Application
Programming Interface n.
A remote interface available
over HTTP(S), designed in a
REST or RPC style.
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
Public
Partner
Private
Microservices
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
“Docs
Like
Code”
Public
Partner
Private
Microservices

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
API
Design
Scope
Consistency
Future-proof
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
API
Design
Docs
Conceptual
Guides / Samples
API Reference
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
Spec
machine-
readable
“Docs
Like
Code”

Metadata
openapi: 3.0.0
info:
title: ipify
version: v1
description: A Simple IP Address API
servers:
- url: 'https://api.ipify.org/'

Paths
paths:
/:
get:
summary: Get client IP
parameters:
- in: query
name: format
description: 'The format to return the response in, i.e. json.'
schema:
type: string
default: json
responses:

Responses / JSON Schemas
responses:
'200':
description: Success response
content:
application/json:
schema:
type: object
properties:
ip:
type: string
example: 88.68.10.107

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
Spec
machine-
readable
Docs
Reference

Manual
Writing
Auto-
Generation
Code
Implementation
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
API
Design
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
Spec
machine-
readable
Manual
Writing
Visual
Tools
API
Design
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
Spec
machine-
readable
Manual
Writing
Visual
Tools
API
Design
Docs
Reference

“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
Spec
machine-
readable
Manual
Writing
Visual
Tools
API
Design
Docs
Reference

Code
Client SDKs
Server Stubs
Mock Servers“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
API
Design
Docs
Conceptual
Guides / Samples
API Reference
Review
“The Good Stuff”
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
Not jobless!
More technical
“Docs
Like
Code”

APIs?
DX
Developer
Experience
Open
API
Spec-
driven
Tech
Writers
“Docs
Like
Code”
Use developer toolchain
for writing
Markdown

What's hot

APIDays - API Design Workshop

Restlet

apidays LIVE New York 2021 - Designing API's: Less Data is More! by Damir Svr...

apidays

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.

[API World 2021 ] - Understanding Cloud Native Deployment

WSO2

apidays LIVE Australia 2020 - Federating API Development at Australia’s large...

apidays

apidays LIVE Hong Kong 2021 - Multi-Protocol APIs at Scale in Adidas by Jesus...

apidays

OpenAPI Spec at Google (Open API Initiative Meetup on 2016-09-15)

Open API Initiative (OAI)

Designing APIs with OpenAPI Spec

Adam Paxton

apidays LIVE London 2021 - Consumer-first APIs in Open Banking by Chris Dudle...

apidays

Tools and techniques for APIs

Jason Harmon

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

apidays

OpenAPI is an the emerging standard for creating, managing and consuming REST APIs. Previously named Swagger, in the last year has been adopted by the Linux Foundation and gained the support of companies like Google, Microsoft, IBM, Paypal, etc. to become a de-facto standard for APIs. In this talk we will review 3 uses cases to apply OpenAPI to enhance and speed-up our developments to create OpenAPI compliant APIs.

Building APIs with the OpenApi Spec

Pedro J. Molina

Bulletproofing Your APIs: Why Users’ Feedback Matters

Pronovix

apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...

apidays

Proliferating OpenAPI at Google

Open API Initiative (OAI)

Following up on last year's talk "Web API, the New Language Frontier", Jérôme presented the latest trends in web API languages, from the release of Swagger 2.0 and how it compares with RAML and API Blueprint, to the new tooling that is emerging around those languages like code editors, visual designers, generators and testing tools. The talk also explained the impact of API languages on development workflows and how API-first and Code-first approaches can be reconciled.

APIdays Paris 2014 - The State of Web API Languages

Restlet

{Re}designing a Developer Portal

Pronovix

Essential Ingredients for a Successful API Program

Jason Harmon

apidays LIVE Hong Kong 2021 - Better API DX with a CLI by Phil Nash, Twilio

apidays

apidays LIVE Australia 2021 - From apps to APIs: how no-code is transforming ...

apidays

The Open API Initiative, s̶i̶x̶ Nine Months and Counting." Are you new to the OAI? At the Sept. 15, 2016 OAI Meetup, we started the evening with a brief overview of the Open API Initiative, some background on the Swagger Project that it's based upon, and how many companies today are collaborating to enable open governance of the OAS 3.0 Spec - as it approaches completion later this year. - presented by Jeff Borek, WW Program Director, Open Cloud Business Development, Software Group, IBM Corporation

9 Months and Counting with Jeff Borek of IBM OpenAPI Meetup 2016 09 15

Open API Initiative (OAI)

What's hot (20)

APIDays - API Design Workshop

apidays LIVE New York 2021 - Designing API's: Less Data is More! by Damir Svr...

[API World 2021 ] - Understanding Cloud Native Deployment

apidays LIVE Australia 2020 - Federating API Development at Australia’s large...

apidays LIVE Hong Kong 2021 - Multi-Protocol APIs at Scale in Adidas by Jesus...

OpenAPI Spec at Google (Open API Initiative Meetup on 2016-09-15)

Designing APIs with OpenAPI Spec

apidays LIVE London 2021 - Consumer-first APIs in Open Banking by Chris Dudle...

Tools and techniques for APIs

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

Building APIs with the OpenApi Spec

Bulletproofing Your APIs: Why Users’ Feedback Matters

apidays LIVE London 2021 - Designing APIs: Less Data is More by Damir Svrtan,...

Proliferating OpenAPI at Google

APIdays Paris 2014 - The State of Web API Languages

{Re}designing a Developer Portal

Essential Ingredients for a Successful API Program

apidays LIVE Hong Kong 2021 - Better API DX with a CLI by Phil Nash, Twilio

apidays LIVE Australia 2021 - From apps to APIs: how no-code is transforming ...

9 Months and Counting with Jeff Borek of IBM OpenAPI Meetup 2016 09 15

Similar to Specification-driven API Design vs Technical Writers

Apidays Paris 2023 - Software and APIs for Smart, Sustainable and Sovereign Societies December 6, 7 & 8, 2023 API design first: A case for a better language Emmanuel Bastien ------ Check out our conferences at https://www.apidays.global/ Do you want to sponsor or talk at one of our conferences? https://apidays.typeform.com/to/ILJeAaV8 Learn more on APIscene, the global media made by the community for the community: https://www.apiscene.io Explore the API ecosystem with the API Landscape: https://apilandscape.apiscene.io/

Apidays Paris 2023 - API design first: A case for a better language, Emmanu...

apidays

API workshop: Introduction to APIs (TC Camp)

Tom Johnson

Raml api designer

D.Rajesh Kumar

REST Coder: Auto Generating Client Stubs and Documentation for REST APIs

Hiranya Jayathilaka

APIsecure - April 6 & 7, 2022 APIsecure is the world’s first conference dedicated to API threat management; bringing together breakers, defenders, and solutions in API security. Securing APIs with Open Standards Tips for makingandbreaking APIs that scale from theSynack Red Team Ryan Rutan, Sr. Director of Community at Synack Red Team Vitthal Shinde, Security Engineer at FICO & Synack Red Team

2022 APIsecure_Securing APIs with Open Standards

APIsecure_ Official

A presentation given by Mandy Whaley, Partner Director of Product, Azure Developer Tools at Microsoft, at our 2024 Austin API Summit, March 12-13. Session Description: TypeSpec is a new API description language developed and used by Microsoft to deliver APIs at a massive scale. Learn how Microsoft uses TypeSpec to deliver high quality services to millions of customers and across tens of thousands of API endpoints. We will show how to use this new language and the related IDE tooling to encapsulate common API patterns into reusable components, up-level API descriptions with business-specific metadata and behaviors, connect API guidelines to development time activities, maintain API consistency, and generate custom assets, all while interoperating with the OpenAPI ecosystem.

APIs at Scale with TypeSpec by Mandy Whaley, Microsoft

Nordic APIs

GraphQL: Enabling a new generation of API developer tools

Sashko Stubailo

Make Your API Catalog Essential with z/OS Connect EE

Teodoro Cipresso

Engineers working on backend data services are often focused on operational concerns like data consistency, reliability, uptime, and storage efficiency. Because each situation calls for a specific set of tradeoffs, one organization can end up with a diverse set of backend databases and services. For the people building the UI and frontend API layers, this diversity can quickly become an issue, especially if the same client needs to call into multiple backends or fetch related objects across different data sources. GraphQL is a language-agnostic API gateway technology designed precisely to solve this mismatch between backend and frontend requirements. It provides a highly structured, yet flexible API layer that lets the client specify all of its data requirements in one GraphQL query, without needing to know about the backend services being accessed. Better yet, because of the structured, strongly typed nature of both GraphQL queries and APIs, it's possible to quickly get critical information, such as which objects and fields are accessed by which frontends, which clients will be affected by specific changes to the backend, and more. In this talk, I'll explain what GraphQL is, what data management problems it can solve in an organization, and how you can try it today.

GraphQL: The Missing Link Between Frontend and Backend Devs

Sashko Stubailo

Join Stormpath .NET Developer Evangelist, Nate Barbettini, to learn best practices for designing your REST API in ASP.NET Core. Nate will explain how to build HATEOS-compliant JSON APIs while supporting security best practices and even improving performance and scale. Topics Covered: What is REST and HATEOS? How to think about RESTful APIs How to model hypermedia in C# Building JSON APIs in ASP.NET Core

Building Beautiful REST APIs with ASP.NET Core

Stormpath

Survival Strategies for API Documentation: Presentation to Southwestern Ontar...

Tom Johnson

API workshop by AWS and 3scale

3scale

API's are at the heart of the modern software development world, we do it everywhere! It's not only a matter of distributed systems, it's in every code that we write, and more often than not - it matters. The focus of this talk is about authoring Public API's between systems, be that different parts within the same distributed system or a fully blown real-world public API and everything in between. Facing such a challenge, one may meet all sorts of dilemmas and consider different strategies and several practices. For instance, how to author specifications, how to approach stability, how to authenticate calls, what practices to consider, and more. Join me in this session as we tackle such questions head-on and see cool demos of code and tools as we build a public API in the process.

Will the Real Public API Please Stand Up? Amir Zuker

CodeValue

Public API

Amir Zuker

APIdays 2015 - The State of Web API Languages

Jerome Louvel

APIdays 2015 - The State of Web API Languages

Restlet

Content Strategy and Developer Engagement for DevPortals

Axway

OpenAPI Specification 3.0 has become the de-facto standard for defining REST APIs. It is a descendant of Swagger and many people still know it by this name. It is a language/framework agnostic way of describing your APIs for both humans and machines. In this talk I will show an example OpenAPI spec document and run through it to demystify OAS. I will also quickly show some tools including my favourite VS Code that will help you in working with OAS. If you are either an API developer or API consumer or just want to be API savvy this talk is for you.

Open API (aka Swagger) - DDD by Night May 2020

Pratik Khasnabis

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.

API Conference 2021

José Haro Peralta

API Documentation presentation to East Bay STC Chapter

Tom Johnson

Similar to Specification-driven API Design vs Technical Writers (20)

Apidays Paris 2023 - API design first: A case for a better language, Emmanu...

API workshop: Introduction to APIs (TC Camp)

Raml api designer

REST Coder: Auto Generating Client Stubs and Documentation for REST APIs

2022 APIsecure_Securing APIs with Open Standards

APIs at Scale with TypeSpec by Mandy Whaley, Microsoft

GraphQL: Enabling a new generation of API developer tools

Make Your API Catalog Essential with z/OS Connect EE

GraphQL: The Missing Link Between Frontend and Backend Devs

Building Beautiful REST APIs with ASP.NET Core

Survival Strategies for API Documentation: Presentation to Southwestern Ontar...

API workshop by AWS and 3scale

Will the Real Public API Please Stand Up? Amir Zuker

Public API

APIdays 2015 - The State of Web API Languages

Content Strategy and Developer Engagement for DevPortals

Open API (aka Swagger) - DDD by Night May 2020

API Conference 2021

API Documentation presentation to East Bay STC Chapter

Recently uploaded

Unlock the secrets to success in the competitive world of food delivery app development with our comprehensive guide for 2024. From innovative features to cutting-edge technologies, discover the strategies that will elevate your food delivery business to new heights. Download now for expert insights and actionable tips for more visit, https://foodorderingwebsite.com/food-delivery-app-development/.

Food Delivery Business App Development Guide 2024

Chirag Panchal

^Clinic ^%[+27788225528*Abortion Pills For Sale In soweto

kasambamuno

^Clinic ^%[+27788225528*Abortion Pills For Sale In witbank

kasambamuno

Operations departments are at the heart of organizational efficiency and effectiveness, constantly assessing performance against strategic objectives and key results. With OnePlan, operations leaders can gain the insights and tools needed to align resources optimally and drive essential outcomes. This webinar will delve into how OnePlan facilitates real-time visibility into performance metrics and resource allocation, enabling operations teams to remain agile and effective. Join us to explore actionable strategies for enhancing your operational efficiency and achieving your key results.

Optimizing Operations by Aligning Resources with Strategic Objectives Using O...

OnePlan Solutions

Transformer Neural Network Use Cases with Links

JinanKordab

This is a classic migration case study (the past, current and the future) at scale from a world-wide company transitioning from Confluent Platform and Confluent Cloud to self-managed Apache Kafka on Kubernetes using Strimzi. At Maersk, we have been architecting, designing and implementing our 3rd generation Event Streaming Platform. This platform is based on Kubernetes in Azure and using Strimzi to operate Apache Kafka at large scale, highly reliable, segregating data based on isolated use cases. Our 2nd generation was based on OnPrem Confluent Platform and Confluent Cloud and this presentation is the story of this migration and reasoning behind it. Furthermore, we would get into details on how we monitor (Grafana, Prometheus), alert (GoAlert and alert as code), operate and provide self-service solutions on top of Strimzi to enable business critical application in Maersk, implemented in GoLang using the GitOps deployment model with Flux and Kustomization among others. Finally, if time allows we will end with a demo of an open-source self service tool to monitor and explore the cluster with most wanted features such as topic message browsing and configuring and restarting connectors.

StrimziCon 2024 - Transition to Apache Kafka on Kubernetes with Strimzi.pdf

steffenkarlsson2

How to download files safely from the internet ? Source: <a href="https://www.downloadsafely.com/">Download Safely</a> -Welcome to Secure Downloading&Surfing. Learn how to safely download files and protect your data while browsing the web. Let's dive into the world of secure surfing! Understanding the Risks Discover the potential threats associated with downloading files from the internet and the impact of malicious software on your device.

how-to-download-files-safely-from-the-internet.pdf

Mehmet Akar

architecting-ai-in-the-enterprise-apis-and-applications.pdf

WSO2

If you weren't able to make it to Florida Dreamin' last Fall, then you are in luck. We are bringing you one of the most talked about sessions during the conference. You won't want to miss this insightful presentation from Cyndy Ferguson, Team Lead, Client Success Manager, Craftsman Technology Group titled: Why I hire and train Junior Admins, and why you should too! Presentation Description: You say you don't have time to hire, train and mentor Junior Admins? But you have time to interview 50 people, none of whom fit your current Salesforce Admin job description? Let me show you how to hire, train, and retain Freshies or Junior Admins, while saving time, money and your sanity. I have developed 30-day, 60-day, 90-day, and 180-day plans to skill up new Admins and make your life easier. Also, join us to get some key highlights for the Summer '24 Release that will impact and provide value to most Orgs. These updates will be available in your Sandbox and Production Orgs during the months of May and June presented by Marc Lester, Engagement Manager, Coastal. Did you know most new features are included with your initial purchase? Explore the latest innovations in the release to maximize your ROI from Salesforce. Some features in Summer ’24 will affect all users immediately after the release goes live, which are already available in your Sandbox and Production Orgs. If you haven't already done so, consider communicating these changes to your users so they understand the updates and know how to best take advantage of them. Other features require direct action by an administrator before users can benefit from the new functionality. Learn about some of each of these features and enhancements and which ones will benefit your organization the most.

Jax, FL Admin Community Group 05.14.2024 Combined Deck

Marc Lester

Salesforce unveiled the Salesforce Zero Copy Partner Network, a global alliance of tech and solution providers developing secure, bidirectional zero-copy interfaces with Salesforce Data Cloud. This innovative approach enables seamless data actioning across the Salesforce Einstein Platform. Brian Miliham, Salesforce’s President and COO, highlighted the challenge companies face with fragmented data. This ecosystem empowers businesses to harness all their data, irrespective of its location, maximizing the potential for personalized customer experiences and facilitating quicker, cost-effective AI integration within Salesforce.

Salesforce Introduced Zero Copy Partner Network to Simplify the Process of In...

CloudMetic

OpenChain @ LF Japan Executive Briefing - May 2024

Shane Coughlan

These are the slides of my OpenSIPS Summit 2024 presentation about automating your test calls. It dives into why automated call testing is crucial, how to integrate it into your CI/CD pipeline and how to extend testing of single calls into load testing and testing of other protocols. The presentation also provides details how open source components such as sipp, asterisk and rtpengine are used to implement agents to generate test calls for SIP, Fax and WebRTC at scale.

Automate your OpenSIPS config tests - OpenSIPS Summit 2024

Andreas Granig

Software Engineering - Part 1 which describes the following topics: Introduction: The evolving role of software, The changing nature of software, Software engineering, A Process Framework, Process Patterns, Process Assessment, Personal and Team Process Models, Process Technology, Product and Process. Process Models: Prescriptive models, Waterfall model, Incremental process models, Evolutionary process models, Specialized process models. Requirements Engineering: Requirements Engineering Task, Initiating the Requirement Engineering process, Eliciting Requirements, developing use cases, Building the analysis model, Negotiating Requirements, Validating Requirements, Software Requirement Document.

Software Engineering - Introduction + Process Models + Requirements Engineering

Prakhyath Rai

Modern binary build systems - PyCon 2024

Henry Schreiner

Unlock the full potential of your software development lifecycle with SpiraPlan's powerful REST APIs. Led by experts from Inflectra and our partner, MVerve, this webinar offers a practical guide to leveraging the API's power for automation, integration, and data-driven insights. Whether you're an API expert or beginner, our recap blog is packed with valuable information to enhance your SpiraPlan experience. The webinar emphasized how SpiraPlan's REST API allows you to: • Automate Workflows: Streamline your processes by automating repetitive tasks. • Integrate with Existing Tools: Seamlessly connect SpiraPlan with your existing software ecosystem. • Build Custom Solutions: Tailor SpiraPlan to your unique needs by developing custom applications and integrations. • Gain Deeper Insights: Extract valuable data from SpiraPlan for advanced reporting and analysis.

From Theory to Practice: Utilizing SpiraPlan's REST API

Inflectra

Alluxio Monthly Webinar May. 14, 2024 For more Alluxio Events: https://www.alluxio.io/events/ Speaker: - ChanChan Mao (Developer Advocate, Alluxio) - Bin Fan (VP of Technology, Alluxio) Running AI/ML workloads in different clouds present unique challenges. The key to a manageable multi-cloud architecture is the ability to seamlessly access data across environments with high performance and low cost. This webinar is designed for data platform engineers, data infra engineers, data engineers, and ML engineers who work with multiple data sources in hybrid or multi-cloud environments. Chanchan and Bin will guide the audience through using Alluxio to greatly simplify data access and make model training and serving more efficient in these environments. You will learn: - How to access data in multi-region, hybrid, and multi-cloud like accessing a local file system - How to run PyTorch to read datasets and write checkpoints to remote storage with Alluxio as the distributed data access layer - Real-world examples and insights from tech giants like Uber, AliPay and more

Alluxio Monthly Webinar | Simplify Data Access for AI in Multi-Cloud

Alluxio, Inc.

Abortion Clinic In Springs ](+27832195400*)[ 🏥 Safe Abortion Pills in Springs...

Medical / Health Care (+971588192166) Mifepristone and Misoprostol tablets 200mg

Abortion Clinic In Pretoria ](+27832195400*)[ 🏥 Safe Abortion Pills in Pretor...

Medical / Health Care (+971588192166) Mifepristone and Misoprostol tablets 200mg

Abortion Clinic Pretoria ](+27832195400*)[ Abortion Clinic Near Me ● Abortion...

Medical / Health Care (+971588192166) Mifepristone and Misoprostol tablets 200mg

The Mythical Technical Debt (Brooke, please, forgive me.) <This talk is designed for a technical audience> In software-intensive systems development, we often face trade-offs between speed and long-term maintainability. These trade-offs accumulate as technical debt, the hidden cost of short-term decisions that can impact future development. Technical debt goes beyond the initial choices made when creating software. It encompasses design decisions, coding practices, or anything that might hinder future development efforts. By effectively identifying and managing this debt, we can build robust and scalable software systems. In this talk, we'll explore different types of technical debt and their impact on projects. We'll delve into practical methods to identify, measure, and reduce it. Finally, we'll see how to turn technical debt into an advantage, using it as a springboard for innovation with real-world examples.

The mythical technical debt. (Brooke, please, forgive me)

Roberto Bettazzoni

Recently uploaded (20)

Food Delivery Business App Development Guide 2024

^Clinic ^%[+27788225528*Abortion Pills For Sale In soweto

^Clinic ^%[+27788225528*Abortion Pills For Sale In witbank

Optimizing Operations by Aligning Resources with Strategic Objectives Using O...

Transformer Neural Network Use Cases with Links

StrimziCon 2024 - Transition to Apache Kafka on Kubernetes with Strimzi.pdf

how-to-download-files-safely-from-the-internet.pdf

architecting-ai-in-the-enterprise-apis-and-applications.pdf

Jax, FL Admin Community Group 05.14.2024 Combined Deck

Salesforce Introduced Zero Copy Partner Network to Simplify the Process of In...

OpenChain @ LF Japan Executive Briefing - May 2024

Automate your OpenSIPS config tests - OpenSIPS Summit 2024

Software Engineering - Introduction + Process Models + Requirements Engineering

Modern binary build systems - PyCon 2024

From Theory to Practice: Utilizing SpiraPlan's REST API

Alluxio Monthly Webinar | Simplify Data Access for AI in Multi-Cloud

Abortion Clinic In Springs ](+27832195400*)[ 🏥 Safe Abortion Pills in Springs...

Abortion Clinic In Pretoria ](+27832195400*)[ 🏥 Safe Abortion Pills in Pretor...

Abortion Clinic Pretoria ](+27832195400*)[ Abortion Clinic Near Me ● Abortion...

The mythical technical debt. (Brooke, please, forgive me)

Specification-driven API Design vs Technical Writers

1. Specification-driven API Design vs. Technical Writers Lukas Rosenstock tcworld18, 15th Nov 2018

2. APIs? DX Developer Experience Open API Spec- driven Tech Writers  “Docs Like Code”

3. APIs? DX Developer Experience Open API Spec- driven Tech Writers API abbr. Application Programming Interface n. A remote interface available over HTTP(S), designed in a REST or RPC style. “Docs Like Code”

4. APIs? DX Developer Experience Open API Spec- driven Tech Writers Public Partner Private Microservices “Docs Like Code”

5. APIs? DX Developer Experience Open API Spec- driven Tech Writers “Docs Like Code” Public Partner Private Microservices

6. APIs? DX Developer Experience Open API Spec- driven Tech Writers API Design Scope Consistency Future-proof “Docs Like Code”

7. APIs? DX Developer Experience Open API Spec- driven Tech Writers API Design Docs Conceptual Guides / Samples API Reference “Docs Like Code”

8. APIs? DX Developer Experience Open API Spec- driven Tech Writers Spec machine- readable “Docs Like Code”

10. Metadata openapi: 3.0.0 info: title: ipify version: v1 description: A Simple IP Address API servers: - url: 'https://api.ipify.org/'

11. Paths paths: /: get: summary: Get client IP parameters: - in: query name: format description: 'The format to return the response in, i.e. json.' schema: type: string default: json responses:

12. Responses / JSON Schemas responses: '200': description: Success response content: application/json: schema: type: object properties: ip: type: string example: 88.68.10.107

13. APIs? DX Developer Experience Open API Spec- driven Tech Writers Spec machine- readable Docs Reference  Manual Writing Auto- Generation Code Implementation “Docs Like Code”

14. ReDoc

15. Swagger UI

16. APIs? DX Developer Experience Open API Spec- driven Tech Writers “Docs Like Code”

17. APIs? DX Developer Experience Open API Spec- driven Tech Writers API Design “Docs Like Code”

18.

19. APIs? DX Developer Experience Open API Spec- driven Tech Writers Spec machine- readable Manual Writing Visual Tools API Design “Docs Like Code”

20. stoplight.io

21. APIs? DX Developer Experience Open API Spec- driven Tech Writers Spec machine- readable Manual Writing Visual Tools API Design Docs Reference  “Docs Like Code”

22. APIs? DX Developer Experience Open API Spec- driven Tech Writers Spec machine- readable Manual Writing Visual Tools API Design Docs Reference  Code Client SDKs Server Stubs Mock Servers“Docs Like Code”

23. APIs? DX Developer Experience Open API Spec- driven Tech Writers Spec machine- readable Manual Writing Visual Tools API Design Docs Reference  Code Code = Spec ? Tests “Docs Like Code”

24. APIs? DX Developer Experience Open API Spec- driven Tech Writers Spec machine- readable Manual Writing Visual Tools API Design Docs Reference  Code Tests Single Source Of Truth “Docs Like Code”