API Contracts Catalog

ProactiveDevs Microservices Ecosystem

Welcome to the API Contracts Repository

This catalog provides interactive documentation for all API specifications in the ProactiveDevs ecosystem. Each API contract is published as a versioned Maven artifact that can be consumed by microservices.

Repository: github.com/roldaiateam/apis-especifications

Deployment: This site is automatically deployed to GitHub Pages when new API versions are published.

Available APIs

API Name Type Latest Versions Documentation
Products REST API OpenAPI 3.0 Snapshot: v0.0.2-SNAPSHOT View Documentation
💡 Tip: Each API page includes a version selector to browse all published versions (stable, snapshot, and unstable). Click "View Documentation" to explore the interactive Swagger UI.

Using API Contracts in Your Microservice

Maven Dependency

Add the GitHub Packages repository and the contract dependency to your pom.xml:

<repositories>
    <repository>
        <id>github</id>
        <url>https://maven.pkg.github.com/roldaiateam/apis-especifications</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

<dependency>
    <groupId>com.proactivedevs.contracts</groupId>
    <artifactId>{api-name}-stable</artifactId>
    <version>{version}</version>
</dependency>

For more information, visit the repository documentation.