jEAP OpenAPI Specification Publisher
jEAP OpenAPI Specification Publisher is a Spring Boot starter that publishes a service's OpenAPI
specification to the jEAP Architecture Repository Service (archrepo). It is a drop-in dependency: once
the jeap.archrepo.url property is set, it reads the OpenAPI document generated by springdoc-openapi
and uploads it on every application start, without any code changes in the consuming service. It provides:
- Automatic upload of the service's OpenAPI specification to the archrepo on the Spring
ApplicationReadyEvent - Asynchronous, best-effort publishing that never blocks startup or fails the application if the upload fails
- OAuth2 client-credentials authentication against the archrepo API
- Optional replacement of the OpenAPI base server URL with the service's deployment FQDN
- Optional Micrometer tracing and timing of the publish operation
Documentation
Start with Getting started, then follow the links below.
| Topic | File |
|---|---|
| Getting started (add the dependency, enable it) | docs/getting-started.md |
| How it works (startup & publish flow) | docs/how-it-works.md |
Configuration reference (jeap.archrepo.*) | docs/configuration.md |
| Authentication (OAuth2 client credentials) | docs/authentication.md |
Modules
This is a single-module Spring Boot starter. The artifact to depend on is jeap-open-api-publisher-starter;
group id is ch.admin.bit.jeap, and the version is managed by the jEAP Spring Boot parent.
| Artifact | Purpose |
|---|---|
jeap-open-api-publisher-starter | Auto-configuration that reads and uploads the OpenAPI specification to the archrepo service |