Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CreateAPI/CreateAPI
Delightful code generator for OpenAPI specs
https://github.com/CreateAPI/CreateAPI
code-generation codegen openapi
Last synced: 7 days ago
JSON representation
Delightful code generator for OpenAPI specs
- Host: GitHub
- URL: https://github.com/CreateAPI/CreateAPI
- Owner: CreateAPI
- License: mit
- Created: 2021-11-29T01:31:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T23:46:03.000Z (4 months ago)
- Last Synced: 2024-11-25T05:48:15.552Z (18 days ago)
- Topics: code-generation, codegen, openapi
- Language: Swift
- Homepage:
- Size: 17.8 MB
- Stars: 416
- Watchers: 11
- Forks: 33
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - CreateAPI - Delightful code generation for OpenAPI specs for Swift written in Swift. (Parsing / Other Parsing)
- awesome-ios - CreateAPI
- awesome-ios-star - CreateAPI - Delightful code generation for OpenAPI specs for Swift written in Swift. (Parsing / Other Parsing)
README
# Create API
Delightful code generation for OpenAPI specs for Swift written in Swift.
- **Fast**: processes specs with 100K lines of YAML in less than a second
- **Smart**: generates Swift code that looks like it's carefully written by hand
- **Reliable**: tested on 1KK lines of publicly available OpenAPI specs producing correct code every time
- **Customizable**: offers a ton of customization options
> Powered by [OpenAPIKit](https://github.com/mattpolzin/OpenAPIKit)
## Installation
### [Mint](https://github.com/yonaskolb/Mint)
```bash
$ mint install CreateAPI/CreateAPI
```
### [Homebrew](https://formulae.brew.sh/formula/create-api)
```bash
$ brew install create-api
```
### Swift Package Plugins
- [Creating a Swift Package Plugin](./Docs/SwiftPackagePlugins.md)
### Make
```bash
$ git clone https://github.com/CreateAPI/CreateAPI.git
$ cd CreateAPI
$ make install
```
## Getting Started
You'll need an [OpenAPI schema](https://swagger.io/specification/) (using 3.0.x) for your API. If your schema has external references, you might also need to bundle it beforehand.
If you have never used CreateAPI before, be sure to check out our tutorial: [Generating an API with CreateAPI](./Docs/Tutorial.md)
CreateAPI can generate complete Swift Package bundles but can also generate individual components to integrate into an existing project. Either way, you'll want to use the `generate` command:
$ create-api generate --help
```
USAGE: create-api generate [--output ] [--config ] [--config-option ...] [--verbose] [--strict] [--allow-errors] [--clean] [--watch] [--single-threaded] [--measure]
ARGUMENTS:
The path to the OpenAPI spec in either JSON or YAML format
OPTIONS:
--output The directory where generated outputs are written (default: CreateAPI)
--config The path to the generator configuration. (default: .create-api.yaml)
--config-option
Option overrides to be applied when generating.
In scenarios where you need to customize behaviour when invoking the generator, use this option to
specify individual overrides. For example:
--config-option "module=MyAPIKit"
--config-option "entities.filenameTemplate=%0DTO.swift"
You can specify multiple --config-option arguments and the value of each one must match the
'keyPath=value' format above where keyPath is a dot separated path to the option and value is the
yaml/json representation of the option.
-v, --verbose Enables verbose log messages
--strict Treats warnings as errors and fails generation
--allow-errors Ignore errors that occur during generation and continue if possible
-c, --clean Removes the output directory before writing generated outputs
--watch Monitor changes to both the spec and the configuration file and automatically
regenerate outputs
--single-threaded Disables parallelization
--measure Measure performance of individual operations and log timings
--version Show the version.
-h, --help Show help information.
```
To try CreateAPI out, run the following commands:
```bash
$ curl "https://petstore3.swagger.io/api/v3/openapi.json" > schema.json
$ create-api generate schema.json --config-option module=PetstoreKit --output PetstoreKit
$ cd PetstoreKit
$ swift build
```
There you have it, a comping Swift Package ready to be integrated with your other Swift projects!
For more information about using CreateAPI, check out the [Documentation](./Docs/).
## Projects using CreateAPI
Need some inspiration? Check out the list of projects below that are already using CreateAPI:
- [App Store Connect API](https://github.com/AvdLee/appstoreconnect-swift-sdk)
- [Swift SDK for Jellyfin](https://github.com/jellyfin/jellyfin-sdk-swift)
- [Google Generative AI SDK](https://github.com/google/generative-ai-swift)
Are you using CreateAPI in your own open-source project? Let us know by [adding it](https://github.com/CreateAPI/CreateAPI/edit/main/README.md) to the list above!
## Contributing
We always welcome contributions from the community via Issues and Pull Requests. Please be sure to read over the [contributing guidelines](./CONTRIBUTING.md) for more information.