β About
Today, CD
(Continuous Delivery) of up-to-date documentation is a crucial step if you want to achieve things at scale.
APIs do not make exception : we deliver embedded swagger, but...
more and more outside collaborators ask for offline documentation, or on API marketplaces.
And (hopefully) :
your outside contributors or clients are more numerous than you.
βοΈ So you have to deliver them an optimal DX
(Developer-Experience) that costs no work to your organization.
π We'll show you how we deliver documentation for :
- π€ Human people
- π€ Third party CI services for integration purposes
π‘ What we'll cover
What we'll show here is how we deliver a static OpenAPI specification (html
and yaml
), as part of the release process.
π With that, it makes it very easy to import your API into any API marketplace, see below on Google apigee
:
π§° Stack
πΏ Demo
Enough talks, let's watch this very cool step by step and short (<10'
) demo from @mbarre :
π Resources
π Date to save
QuarkusIO@quarkusioJoin us next Wednesday for Quarkus Insights Ep.106, Quarkiverse Extension Spotlight: OpenApi Generator. Ricardo Zanini @zaninirica joins us to discuss the extension, how itβs used, and whatβs new.
bit.ly/quarkusinsights13:00 PM - 21 Oct 2022
Top comments (3)