liveBook · Manning

Api artifact store

As explained in Automating API Delivery

An API artifact store is a storage system that retains generated API artifacts and supports their retrieval by teams and applications.

An API artifact store retains processed API definitions so later pipeline stages, developer portals, SDK generators, and external consumers can retrieve the same publishable artifact. The pipeline stores the transformed definition separately from multifile source definitions and application executables. section 9.1 section 9.1.1

A build pipeline can prepare and publish the artifact through these steps:

  • Bundle multifile OpenAPI definitions into one file. section 9.1
  • Filter internal endpoints marked with x-internal, remove unused components, and sort fields consistently. section 9.1
  • Lint the resulting definition before making it available for publication or downstream generation. section 9.1
  • Upload the processed OpenAPI definition to an API artifact store for retrieval by later pipeline stages and consumers. section 9.1 section 9.1.1

Generated external API definition

A product API repository can create build-output, bundle openapi.yaml with Redocly CLI, filter x-internal endpoints, remove unused schemas and responses, sort fields, and lint the final api.yaml. The pipeline then stores that processed definition in Apicurio API Registry, where the developer portal can generate API reference material and SDKs can consume it.

How Automating API Delivery covers it

How deep it goes
Explains the store within an automated transformation workflow, but does not detail registry administration, retention, or access-control policies.
Examples
Uses Apicurio API Registry, processed OpenAPI definitions, Redocly CLI, openapi-filter, openapi-format, and Spectral linting.
What it assumes
Assumes familiarity with multifile OpenAPI definitions and CI/CD pipelines while demonstrating the transformation commands from the build stage.
What you can do after
Operate/configure a pipeline that generates, validates, stores, and retrieves a publishable OpenAPI artifact.
How it connects
Connects OpenAPI, CI/CD pipelines, developer portals, SDK generation, API artifact management, and API definition transformation.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.