NAME
openapi-linter - Validate and lint OpenAPI specification files.
VERSION
Version 0.18
SYNOPSIS
openapi-linter --spec api.yaml [options]DESCRIPTION
openapi-linter is a command-line utility designed to analyse OpenAPI (Swagger) specification files for structural correctness and best practices. It supports both standard linting and strict schema validation.
OPTIONS
- --spec <specfile>
-
Required. Path to the OpenAPI specification file. Supports both YAML and JSON formats.
- --version <version>
-
Explicitly specify the OpenAPI version (e.g.,
3.0.3,3.1.0). If omitted, the linter attempts to detect the version from the spec file. - --json
-
Enables machine-readable output. Results will be printed as a pretty-printed JSON object containing a summary and an array of issues.
- --validate
-
Switches mode from general linting to strict schema validation against official OpenAPI meta-schemas.
- --help
-
Displays a brief usage summary and exits.
EXIT STATUS
- 0
-
Success. No errors or warnings were found.
- 1
-
Issues found. One or more errors or warnings were detected in the specification.
- 2
-
Invalid arguments. The script was called with incorrect parameters or a missing spec file.
EXAMPLES
# Basic linting
openapi-linter --spec api.yaml
# Run strict schema validation
openapi-linter --spec api.json --validate
# Output results to a file in JSON format
openapi-linter --spec api.yaml --json > report.jsonAUTHOR
Mohammad Sajid Anwar, <mohammad.anwar at yahoo.com>
REPOSITORY
https://github.com/manwar/OpenAPI-Linter
LICENSE AND COPYRIGHT
Copyright (C) 2026 Mohammad Sajid Anwar.
This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at: http://www.perlfoundation.org/artistic_license_2_0 Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license. If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license. This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder. This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed. Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.