Feather OpenAPI

The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Swift in a type-safe way.

Features

• Type-safe interface for building OpenAPI documents
• Automatic identifier generation and resolution
• DocC-based API Documentation
• Unit tests and code coverage

Requirements

• Swift 6.1+
• Platforms:
  • Linux
  • macOS 15+
  • iOS 18+
  • tvOS 18+
  • watchOS 11+
  • visionOS 2+

Installation

Use Swift Package Manager; add the dependency to your Package.swift file:

.package(url: "https://github.com/feather-framework/feather-openapi", exact: "1.0.0-beta.3"),

Then add FeatherOpenAPI to your target dependencies:

.product(name: "FeatherOpenAPI", package: "feather-openapi"),

Usage

API documentation is available at the following link.

Warning

This repository is a work in progress, things can break until it reaches v1.0.0.

Development

• Build: swift build
• Test:
  • local: swift test
  • using Docker: make docker-test
• Format: make format
• Check: make check

Contributing

Pull requests are welcome. Please keep changes focused and include tests for new logic.