Openapi Boilerplate

Overview:

The OpenAPI linter is a tool for working with OpenAPI Specification (OAS) projects. It provides a starter template that helps organize and manage OpenAPI documents by splitting them into smaller files. This template also includes commands for building, linting, and previewing the OpenAPI document from the terminal. By using this template, users can create modular and maintainable OpenAPI projects.

Features:

• Write OpenAPI definitions in different files: Allows users to split their OpenAPI spec into multiple files for better organization and easier maintenance.
• Combine all files with redocly-cli: Provides a command to combine all the split files into one consolidated OpenAPI file using the redocly-cli tool.
• Validate and lint the OpenAPI document with stoplight/spectral: Offers a command to validate and lint the OpenAPI document using the stoplight/spectral tool, ensuring it follows the OpenAPI 3.0 Specification.
• Publish reference docs with Redoc & GitHub Pages: Allows users to generate reference documentation for their API using Redoc and automatically publish it to GitHub Pages.

Summary:

The OpenAPI linter is a valuable tool for developers working with OpenAPI Specification projects. It provides a template that helps organize OpenAPI documents by splitting them into smaller files, making them easier to maintain. Additionally, it offers commands for building, linting, and previewing the OpenAPI document from the terminal. With this tool, developers can create modular and maintainable OpenAPI projects that are easy to document and contribute to.