SwagGen

This is a Swift command line tool that generates client code based on a Swagger/OpenAPI Spec

It has many advantages over the official swagger-codegen java tool such as speed, configurability, simplicity, extensibility, and an improved templating language.

The default Swift templates it generates are also much improved with support for model inheritance, shared enums, mutable parameter structs, convenience initialisers and many more improvements.

Install

Make sure Xcode 8 is installed and run the following commands in the same directory as this repo. You can either build via the Swift Package Manager on the command line or Xcode

1. Command Line

swift build

This compiles a release build via the Swift Package Manager. You can find the output in the build directory which by default is at .build/debug/SwagGen. You can move it out of there or simply run it:

.build/debug/SwagGen ..arguments

2. Xcode

swift package generate-xcodeproj

will create an xcodeproj file that you can open, edit and run in Xcode, which also makes editing any code easier.

If you want to pass the required arguments when running in XCode, you can edit the scheme to include launch arguments.

Usage

Use SwagGen -help to see the list of options:

• spec (required): This is the path to the Swagger spec. It can either be a file path or a web url to a YAML or JSON file

• template: (required): This is the path to the template config yaml file. It can either be a direct path to the file, or a path to the parent directory which will by default look for /template.yml

• destination: The directory that the generated files will be added to.

• option: An option that will be merged with the template config options with those in this argument taking precedence, meaning any existing options of the same name will be overwritten. This argument can be repeated to pass in multiple options. Options must specify the option name and option value seperated by a colon, with any spaces contained in quotes. The following formats are allowed:

  • -- option myOption:myValue
  • -- option "myOption: my value"
  • -- option myOption:" my value"

• clean: Controls if and how the destination directory is cleaned of non generated files. Options are:

  • none: no files are removed (default)
  • all: all other files are removed
  • leave.files: all files and directories except those that start with . in the destination directory are removed. This is useful for keeping configuration files and directories such as .git around, while still making sure that items removed from the spec are removed from the generated API.

Example:

SwagGen --template Templates/Swift --spec http://myapi.com/spec --destination generated --option name:MyAPI --option "customProperty: custom value --clean leave.files"

For the Swift template, a handy option is name, which changes the name of the generated framework from the default of API. This can be set in the template or by passing in --option name:MyCoolAPI.

Templates

Templates are made up of a template config file, a bunch of Stencil files, and other files that will be copied over during generation

Template config

This is the configuration and manifest file for the template in YAML or JSON format. It can contain:

• formatter: Optional formatter to use. This affects what properties are available in the templates and how they are formatted e.g. Swift
• templateFiles: a list of template files. These can each have their paths, contents and destination directories modified through Stencil tags. One template file can also output to multiple files if they path is changed depending on a list context. Each file contains:
  • path: relative path to the template config. The extension is usually .stencil or the type it is going to end up as
  • context: optional context within the spec. This is provided to the generated file, otherwise the full context will be passed. If this is a list then a file will be created for each object and the context within that list is used. (e.g. a file for every model in the spec definitions gets it's own definition context). Note that properties in the template options field can be used here
  • destination: optional destination path. This can contain stencil tags whose context is that from the context above. e.g. if context was definitions then the path could be Models/{{ type }}.swift and the filename would be the type of the definition. If this is left out the destination will be the same as the path, relative to the final destination directory. If it resolves to an empty string it will be skipped and not generated.
• copiedFiles: this is an array of relative paths that will be copied to the destination. They can be files or directories. This is used for files that won't have their contents, filenames or paths changed.
• options: these are the options passed into every stencil file and can be used to customize the template. These options are merged with the options argument, with the argument options taking precendance. These options can be references in template file paths and their contents.

An example template for Swift can be found here

Template Files

These files follow the Stencil file format outlined here https://stencil.fuller.li

Formatters

Formatters change what information is available to the templates and how it's formatted. They can be specified via the formatter property in the template config. Usually these would map to a specific target language, but can be customized for different purposes.

Output Languages

SwagGen can be used to generate code for any language. At the moment there is only a formatter and template for Swift

---

Attributions

This tool is powered by

• custom fork of Stencil by Kyle Fuller
• Spectre by Kyle Fuller
• PathKit by Kyle Fuller
• Commander by Kyle Fuller
• Yams by JP Simard
• JSONUtilities by Luciano Marisi
• Yams by JP Simard

Contributions

Pull requests and issues are welcome

License

SwagGen is licensed under the MIT license. See LICENSE for more info.