💻 Deprecating a package with 200,000 installs a week feels funny, but I've been waiting for a chance to bin off swagger-cli for ages. It's not being maintained (some upstream dependencies are which helps) but even the name is out of date. Thankfully the #Redocly CLI does everything it did, but better, so I recommend you go use that.

More deprecations of old #OpenAPI tooling to come as I find more viable modern alternatives.

#APIDesign #APIDevelopment #OpenSource
https://www.npmjs.com/package/@redocly/cli

💻 Woah, I'm reviewing @Redocly CLI and I just noticed the amazing split command!

$ redocly split api/openapi.yaml --outDir output/

This will neatly split a sprawling messy #OpenAPI description into multiple documents using $ref, reducing duplication, making it easier to work with.

Get it: https://github.com/Redocly/redocly-cli/

#APIDevelopment #APIDesign #REST #HTTP

Feedback from last week's newsletter raised a provocative question: is API product management a *role* or a *person*?

https://netapinotes.substack.com/p/is-api-product-management-a-role

#productManagement #APIDesign #organizationalStructure

An important quality of #apidesign is #minimalism, also called #orthogonality.
This is a quality shared with programming language design as well.

Adding new terms or concepts complicates the design. It adds rules, exceptions, and quirks, thus making it harder to learn.

I'm pleased to share that the script and slides for my recent Carmax/Edmunds DevOps Days conference talk, 'Separating AI Fact from Fiction for Accelerated API Development' has now been posted online.

You can find it on my website here: https://matthewreinbold.com/2023/06/23/SeparatingAIFactFromFiction

You can also read a bit more about why I get a bit exasperated about the inevitable question, "What's the prompt?" on my newsletter: https://netapinotes.substack.com/p/how-to-use-ai-for-better-api-creation

#AI #ChatGPT #API #APIDesign #softwareLifecycle

Are you ready to level up your understanding of #APIEvolution?

Brandon Byars shares key insights from nearly a decade of changes in API evolution. Discover the patterns of evolution, understand the tradeoffs between API elegance, obviousness & stability, and embrace API evolution as a product management concern.

Watch the #InfoQ video with #transcript included: https://bit.ly/4437KX3

#SoftwareArchitecture #API #APIdesign

API Design Patterns: Best Practices for Building Resilient APIs - Introduction
API design patterns are essential for creating reliable, scalable, an... - https://readwrite.com/api-design-patterns-best-practices-for-building-resilient-apis/ #apidesignpatterns #apidocumentation #developerportal #apimarketplace #apigateways #restfulapis #apigateway #developer #apidesign #digital #tech #rest #api

James Higginbotham has heavily influenced my approach to collaboratively designing distributed applications and API programs. I had a chance to sit down and discuss his methodologies in the first episode of the Compiling! Podcast. We then launched into a discussion that affects just about everyone in tech - back health and the important of physical therapy. Give it a listen!

#compiling #podcast #api #apidesign

https://compiling.publicgeeking.com/episodes/james-higginbotham/

📢New in MEAP📢

Improve #API speed, quality, & cost by automating your #APIdesign and delivery proces!

Discover the perfect balance between speed and usability by applying #DevOps automation principles to your #APIs: http://mng.bz/x4eX

#APIOps #RESTAPI #API

:curses profusely:

There's a solution. I can find it.

...oh, good. There are two solutions, and they both have drawbacks.

:exasperated sigh:

#DataModelling #Taxonomy #APIdesign #Docker

Not everything can be automated, and sometimes product & architecture needs can conflict.

Make your #APIdesign review a time when manually enforced conventions are checked, customer language is validated, and final alignment is solidified.

More insights in this #InfoQ article by Jason Harmon: https://bit.ly/3qdqgww

#SoftwareArchitecture #API

I had a great time and many insights attending @mariofusco talk on #java #apidesign during Devoxx Greece 2023.

This is relevant for Web APIs as well. It showcases how the design adapts to the characteristics and constraints of the protocol, but the goals…https://lnkd.in/dBsAe8ya

I'm pretty stoked with this directory structure builder API that I've been working on as part of #RIFE2 #bld. It's pretty common to generate a directory hierarchy with files coming from various places and having specific permissions before archiving everything into a zip file.

I felt this was pretty cumbersome with #JDK calls, especially since the structure of the files is not immediately visible from the code. This builder visualizes everything in a single glance.

#java #coding #apidesign

My team over at APIs You Won’t Hate has grown to three, and Alexander is putting out brilliant content. Our new newsletter has links to stuff I’ve never heard of and need to go learn about! New article from me as well. #api #software #apidesign https://apisyouwonthate.com/newsletter/back-and-better-than-ever-apis-you-wont-hate-monthly-newsletter/

#API #APIs #APIDesign: "In this guide, we will answer the key question of ‘what is API design,’ as well as cover the basics of API design.

API design is the collection of planning and architectural decisions you make when building an API. Your basic API design influences how well developers are able to consume it and even how they use it.

Just like website design or product design, API design informs the user experience. Good API design principles meet initial expectations and continue to behave consistently and predictably." https://stoplight.io/api-design-guide

#APIs #APIDesign #APIDocumentation #TechnicalWriting #UX: "The programmatic equivalent of UX Writing is API Design. The words that you use to describe your API enable conversations between software and people - it’s just a bit more structured and mechanical. That’s why technical writers are uniquely suited to assist technical teams in doing API design, especially when an API First design approach is being followed.

The above is the abstract from my talk When documenting is designing: How to assist API design as a technical writer from Write the Docs Prague."

https://passo.uno/posts/how-to-assist-api-design-as-a-technical-writer/

The Language-Oriented Approach to API Development
https://smizell.com/language-oriented-approach/title-page.html

"... an approach that encourages people to create their own language for the way they talk about APIs and to capture that language in a DSL. " -- @smizell

#api360
#apiDesign

Unlock the full potential of cloud-native microservices with Rohit Bhardwaj'd 10-step methodology for designing superior APIs. Join us at #GID2023 for the talk "Architecting Cloud-Native Microservices" & learn how to tackle common challenges like scalability & performance issues. Ideal for Architects, Technical Leads, Programmers, & Solution Architects: https://developersummit.com/session/architecting-cloud-native-microservices #CloudNative #APIDesign #MicroservicesArchitecture

Introducing Cadl: Microsoft’s concise API design language

https://www.infoworld.com/article/3683909/introducing-cadl-microsofts-concise-api-design-language.html

"With Cadl, you can write a 500-line OpenAPI definition in 50 lines of code. It’s a logical way for architects and developers to construct and constrain APIs."

#api360 #apiDesign #cadl

Event Sourcing Versus Event-Driven Architecture

https://medium.com/geekculture/event-sourcing-versus-event-driven-architecture-753aa5a5d0f6

"event-sourcing involves using events to persist the data changes. In contrast, event-driven architecture is about communicating events with data changes between service boundaries."

#apiNews #apiDesign