February 2025 Product Highlights: OpenAPI Linting on GitHub and enhanced Portal customization

This month’s release introduces the APIMatic OpenAPI Linter for GitHub, enabling high-quality API definition enforcement directly within CI/CD workflows. We have also enhanced our Docs as Code workflow with asynchronous API portal generation for large ecosystems. Additionally, new customization options, improved theming, and several bug fixes ensure a smoother experience across all SDKs and API documentation.

Ensure High-Quality API Definitions with APIMatic’s GitHub App

We’ve launched the APIMatic OpenAPI Linter, a GitHub App designed to maintain high-quality OpenAPI definitions optimized for Code Generation and API Documentation. You can now enforce API definition quality at scale and integrate consumer experience considerations directly into your development workflow.

Key Features:

• Automated PR Validation – Run checks automatically on pull requests using over 1,200 CodeGen-specific rules.
• GitHub Checks integration – View validation results directly within PRs for rapid issue resolution.
• Multi-Definition Support – Validate multiple OpenAPI files within a single repository.
• Comprehensive issue reports – Generate shareable, detailed insights and improvement suggestions.

This expands our suite of quality tools, including Score my API and the APIMatic VS Code Extension.

Learn more in our documentation or install the app via the GitHub Marketplace.

Enhanced Theming with Dark Mode

We've introduced native Dark Mode support to the Developer Portal, providing a seamless viewing experience that reduces eye strain. With updated customization capabilities, you have greater flexibility to align your portal’s appearance with your brand identity.

Learn how to enable Dark Mode on your Developer Portal.

Asynchronous Docs as Code Workflow

Generating portals for large, complex API ecosystems is now more efficient. Our Docs as Code offering now supports an Asynchronous workflow; you can trigger generation and receive a callback notification when the portal is ready for deployment.

Read more about the Async Docs as Code workflow.

📖 Blog: How to Design a Quick Start Guide

A great quick start guide provides the minimal steps necessary for developers to achieve their first successful API call. Read the full guide here.

🛠 Improvements

• Test Configuration: Python SDK now supports configuring test settings via environment variables.
• HTTP Verbs Display: Portal setting enableHttpVerbsForAllLangs now allows HTTP method tags (GET, POST, etc.) in the navigation bar for all languages.
• Deprecated Endpoint Visibility: Improved labeling and UI guidance for deprecated endpoints to help developers find recommended alternatives.
• Custom Validation Rules: Enforce constraints on objects not explicitly marked "required" in the OpenAPI spec using custom rules.
• `x-unique-name` Extension: Disambiguate similar parameter names or create more developer-friendly aliases without modifying your backend implementation.

🐞 Bug Fixes

• [Java] Enabled automatic retries in OkHttp for transient network failures.
• [PHP] Fixed type errors in token fetch calls when ReturnCompleteHttpResponse is enabled.
• [Python] Corrected string representation of models and improved docstring formatting.
• [Go] Fixed OAuth 2.0 refresh token pointer conversion issues.
• [Python, Ruby] Fixed OAuth 2.0 Auth URL generation and token flow parameter handling.
• [API Specs] Fixed issues where empty XML fields were ignored in examples.
• [Validator] Resolved false-positive violations for inline schemas with 'title' properties.

⚠️ Deprecations & Breaking Changes

The themeOverrides object in the build file is now deprecated. Please migrate to the new theme object. While existing portals using themeOverrides will remain functional, they will not receive future visual updates.

• Documentation: Legacy themeOverrides
• Documentation: New theme object