The APIMatic OpenAPI Linter GitHub App automatically validates and lints your OpenAPI definitions within GitHub repositories. Every time you create or update a pull request, the app ensures your API definitions meet high standards for both code generation and documentation generation, helping you maintain consistency and quality across your API projects.

Features

• 1200+ Rules: Enforce API best practices.
• Automatic Validation: Runs on PR creation/updates.
• GitHub Checks: Blocks PR merges if errors exist.
• Audit Reports: Generates shareable validation reports.
• Multi-File Support: Validates multiple OpenAPI files.
• API Merging: Supports merged definitions.
• Custom Configurations: Enable/disable checks, specify rules.

Setup

1. Install & Authorize

Click Install and log in with your APIMatic account. View all repositories where the app is installed, along with detected OpenAPI definitions.

Note: If you lack permissions, a request is sent to your organization owner.

2. Configure Repository (Optional)

By default, the app auto-detects OpenAPI file changes. To specify files explicitly, add .apimaticsettings.json:

{
  "OpenAPIDefinitionPaths": ["path/to/openapi.yaml"],
  "IgnoreValidationErrors": false
}

3. Validate OpenAPI Definitions

On PR creation or updates, the app:

• Validates OpenAPI files.
• Posts validation results as comments.
• Provides a link to the full validation report.

GitHub Checks Integration

• Passes Validation → PR can be merged.
• Fails Validation → PR is blocked (if branch protection is enabled).

Workflow

1. Push OpenAPI Definitions
2. Push Configuration File (if needed)
3. Create/Update PR
4. Automatic Validation
5. PR Comment & Status Update

Customization & Support

• Customize validation rules
• Define custom rules
• APIMatic VSCode Extension: Install here
• Contact Support