https://github.com/feather-framework/feather-openapi

The FeatherOpenAPI library makes it easy to define OpenAPI specifications using Swift in a type-safe way.
https://github.com/feather-framework/feather-openapi

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/feather-framework/feather-openapi
• Owner: feather-framework
• License: mit
• Created: 2023-11-22T21:59:27.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2026-03-24T22:48:36.000Z (3 months ago)
• Last Synced: 2026-03-25T22:21:43.641Z (3 months ago)
• Language: Swift
• Homepage:
• Size: 214 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Agents: AGENTS.md

Awesome Lists containing this project

README

          
# Feather OpenAPI

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

[

    ![Release: 1.0.0-beta.7](https://img.shields.io/badge/Release-1%2E0%2E0--beta%2E7-F05138)

](

    https://github.com/feather-framework/feather-openapi/releases/tag/1.0.0-beta.7

)

## 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+](https://img.shields.io/badge/Swift-6%2E1%2B-F05138)

![Platforms: Linux, macOS, iOS, tvOS, watchOS, visionOS](https://img.shields.io/badge/Platforms-Linux_%7C_macOS_%7C_iOS_%7C_tvOS_%7C_watchOS_%7C_visionOS-F05138)

- 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:

```swift

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

```

Then add `FeatherOpenAPI` to your target dependencies:

```swift

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

```

## Usage

[

    ![DocC API documentation](https://img.shields.io/badge/DocC-API_documentation-F05138)

](

    https://feather-framework.github.io/feather-openapi/

)

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](https://github.com/feather-framework/feather-openapi/pulls) are welcome. Please keep changes focused and include tests for new logic.