Question 1

How do I generate a Swift Package from an OpenAPI spec using CreateAPI?

Accepted Answer

Run 'create-api generate' with your spec file and output directory, such as 'create-api generate schema.json --output MyAPIKit'. This creates a compilable Swift Package ready for integration, as shown in the README tutorial.

Question 2

CreateAPI vs swagger-codegen for Swift: which is better?

Accepted Answer

CreateAPI is written in Swift and focuses on idiomatic, handcrafted-like code with fast performance, while swagger-codegen is more general but may produce less Swift-optimized output. CreateAPI is often preferred for Swift-specific projects due to its integration and customization.

Question 3

Can CreateAPI handle GraphQL APIs?

Accepted Answer

No, CreateAPI is designed specifically for OpenAPI (Swagger) specifications and does not support GraphQL or other non-RESTful API types. You'll need alternative tools for GraphQL code generation.

Question 4

How to customize generated model names in CreateAPI?

Accepted Answer

Use the configuration file (.create-api.yaml) or command-line options like '--config-option entities.filenameTemplate=%0DTO.swift' to tailor naming conventions and file structures, as detailed in the help documentation.

Question 5

Is CreateAPI suitable for large teams?

Accepted Answer

Yes, its reliable and consistent code generation aids team collaboration, but all members must understand the configuration to avoid inconsistencies, and it requires a well-maintained OpenAPI spec.

Question 6

How to watch for changes in the OpenAPI spec with CreateAPI?

Accepted Answer

Use the '--watch' flag during generation to monitor changes to both the spec and configuration file, automatically regenerating outputs, though this may not handle all edge cases seamlessly.

CreateAPI

What is CreateAPI?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions