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
$ mint install CreateAPI/CreateAPI
$ brew install create-api
$ git clone https://github.com/CreateAPI/CreateAPI.git
$ cd CreateAPI
$ make installYou'll need an OpenAPI schema (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
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 <input> [--output <output>] [--config <config>] [--config-option <config-option> ...] [--verbose] [--strict] [--allow-errors] [--clean] [--watch] [--single-threaded] [--measure]
ARGUMENTS:
<input> The path to the OpenAPI spec in either JSON or YAML format
OPTIONS:
--output <output> The directory where generated outputs are written (default: CreateAPI)
--config <config> The path to the generator configuration. (default: .create-api.yaml)
--config-option <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:
$ 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.
Need some inspiration? Check out the list of projects below that are already using CreateAPI:
Are you using CreateAPI in your own open-source project? Let us know by adding it to the list above!
We always welcome contributions from the community via Issues and Pull Requests. Please be sure to read over the contributing guidelines for more information.