apigenie commands
Since 0.13.0, apigenie commands lists every command of apigenie. With --json it prints every command with
its positional arguments and options, as data for scripts and coding agents.
apigenie-generator commands and apigenie-catalog commands do the same for those binaries. The
list is read from the command-line parser of the binary, so it matches what that binary accepts.
The rest of this page is written from the same lists: every command of the three binaries, with
its arguments and options.
Usage
apigenie commands [--json]
Without options, each command takes one line: its full name and the first sentence of its description.
apigenie
apigenie bundle Bundle an OpenAPI, Swagger or AsyncAPI document and the local files it references, or a Protobuf (.proto) file and the files it imports, into a single file.
...
apigenie config check Validate a configuration file against the schema; exits with 2 when it has errors, printing each with its position and JSON pointer.
apigenie config schema Print the JSON Schema (draft-7) of the configuration file, or of one section of it.
...
JSON output
--json prints one document with the binary as its root command. Each command has its name, its
full command line, its description, its positional arguments, its options and its
subcommands in commands. Each argument and option has its description and the number of values
it takes: minValues, and maxValues unless it takes any number. It has its choices when it
accepts only those, and says whether it is required or repeatable. A positional argument is
required when its minValues is above 0. An option also has its names and, when it takes a
value, the value name: the one the help shows, or VALUE where the help shows VAR. Hidden options and internal commands are left out.
The JSON Schema describes the document.
apigenie commands --json
{
"formatVersion": 1,
"name": "apigenie",
"command": "apigenie",
"description": "",
"arguments": [],
"options": [
{
"names": ["-h", "--help"],
"description": "shows help message and exits",
"minValues": 0,
"maxValues": 0,
"required": false,
"repeatable": false
},
...
],
"commands": [
{
"name": "bundle",
"command": "apigenie bundle",
"description": "Bundle an OpenAPI, Swagger or AsyncAPI document and the local files it references, or a Protobuf (.proto) file and the files it imports, into a single file.",
"arguments": [
{
"name": "INPUT",
"description": "Path to the OpenAPI, Swagger, AsyncAPI or Protobuf (.proto) file.",
"minValues": 1,
"maxValues": 1,
"required": true,
"repeatable": false
}
],
"options": [
...
{
"names": ["-I", "--proto-path"],
"value": "DIR",
"description": "Directory in which Protobuf imports are searched. Can be repeated. Defaults to the directory of the input file.",
"minValues": 1,
"maxValues": 1,
"required": false,
"repeatable": true
},
...
],
"commands": []
},
...
]
}
Options
| Option | Description |
|---|---|
--json |
Prints the commands as one JSON document, described above, instead of the outline. |
Exit status
0 when the commands are printed. 2 on an unknown option or argument.
The commands of each binary
The commands of apigenie, apigenie-generator and apigenie-catalog follow, from the commands of
the development version this site is built from. Besides the options listed, every command takes
-h/--help, which prints its help, and --json.
apigenie
apigenie [OPTIONS] COMMAND
| Argument or option | Value | Description |
|---|---|---|
-h, --help |
shows help message and exits | |
-v, --version |
prints the version (and those of apigenie, apigenie-generator, apigenie-server and apigenie-catalog installed next to it) and exits |
Commands: bundle, config, convert, credits, format, license, lint, overlay, diff, changelog, evolve, i18n, init, test, run, commands, completion.
apigenie bundle
Bundle an OpenAPI, Swagger or AsyncAPI document and the local files it references, or a Protobuf (.proto) file and the files it imports, into a single file.
Reference: apigenie bundle
apigenie bundle [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI, Swagger, AsyncAPI or Protobuf (.proto) file. | |
-o, --output |
OUTPUT |
Path to the bundled file; for OpenAPI, Swagger and AsyncAPI, its extension selects JSON or YAML. Required. |
-I, --proto-path |
DIR |
Directory in which Protobuf imports are searched. Can be repeated. Defaults to the directory of the input file. Can be given more than once. |
apigenie config
Print the effective configuration: the values of the configuration file (apigenie.yaml found in the current directory or a parent up to the root of the repository, or –config), those set by environment variables, and the defaults of the settings the file leaves out. ‘config check’ validates a configuration file, ‘config schema’ prints its JSON Schema.
Reference: apigenie config
apigenie config [OPTIONS] COMMAND
| Argument or option | Value | Description |
|---|---|---|
--config |
CONFIG |
Path to the configuration file; replaces the one found in the repository. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
--origin |
Annotate each value with where it comes from: the configuration file, an environment variable, or the defaults. | |
--for |
SECTION |
Print only this section: catalog, scripts, lint, format, diff, generate, generate.<target> (e.g. generate.client_go) or mock. |
Commands: check, schema.
apigenie config check
Validate a configuration file against the schema; exits with 2 when it has errors, printing each with its position and JSON pointer.
Reference: apigenie config check
apigenie config check [OPTIONS] [FILE]
| Argument or option | Value | Description |
|---|---|---|
FILE |
Path to the configuration file. Defaults to the one found in the repository. |
apigenie config schema
Print the JSON Schema (draft-7) of the configuration file, or of one section of it.
Reference: apigenie config schema
apigenie config schema [OPTIONS]
| Argument or option | Value | Description |
|---|---|---|
--for |
SECTION |
Print the schema of this section only: catalog, scripts, lint, format, diff, generate, generate.<target> or mock. |
--standalone-server |
Print the schema of a standalone apigenie-server configuration file (apigenie-server.yaml), whose root holds the settings of commands.mock. | |
-o, --out |
FILE |
Path to the output file. Defaults to standard output. |
apigenie convert
Convert an API specification to another format and version (experimental, outside the 1.0 compatibility promise).
Reference: apigenie convert
apigenie convert [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the API specification to convert. | |
--from |
SOURCE |
Source format: swagger2 (Swagger 2.0), wsdl (WSDL 1.1) or jsonschema (a JSON Schema document of draft 2019-09 or 2020-12). Detected from the input when omitted: XML is WSDL, a document with swagger is Swagger 2.0, any other JSON Schema. One of swagger2, wsdl, jsonschema. |
--to |
TARGET |
Target format and version: openapi32 for Swagger 2.0, openapi31 for WSDL, and draft7, draft4 or openapi30 (the Schema Object of OpenAPI 3.0) for a JSON Schema. One of openapi31, openapi32, draft7, draft4, openapi30. Required. |
--format |
FORMAT |
Output serialization format. Defaults to the input format (YAML for WSDL). One of json, yaml. |
-o, --output |
OUTPUT |
Path to the converted API specification. Defaults to standard output. |
apigenie credits
Show credits to 3rd party libraries used in this project.
Reference: apigenie credits
apigenie credits [OPTIONS]
apigenie format
Format one or more OpenAPI, Swagger, AsyncAPI, Protobuf (.proto) or GraphQL (.graphql) files.
Reference: apigenie format
apigenie format [OPTIONS] FILES...
| Argument or option | Value | Description |
|---|---|---|
FILES |
Path to OpenAPI, Swagger, AsyncAPI, Protobuf (.proto) or GraphQL (.graphql, .graphqls, .gql) files to format. Can be given more than once. | |
--config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
--check |
Checks that the files are formatted, without writing anything: prints the files that would change, and exits with 1 when there are any. | |
--strip-comments |
Drops the comments of the files instead of keeping them (GraphQL descriptions are kept). | |
--openapi-fragment |
KIND |
Formats the files as OpenAPI fragments whose root is the given object: schema, pathItem, operation, parameter, requestBody, response, header, example, link, securityScheme or components. |
--layout-from |
REFERENCE |
Puts the keys of the file in the order of another version of it, such as the committed one (git show HEAD:./openapi.yaml > committed.yaml): keys that version has keep its order, and new keys stay after the key they follow. A property order of the configuration other than original applies after it. Takes one OpenAPI, Swagger or AsyncAPI file. |
--output |
OUTPUT |
Path to the output file or directory. |
apigenie license
Show licenses of 3rd party libraries used in this project.
Reference: apigenie license
apigenie license [OPTIONS]
| Argument or option | Value | Description |
|---|---|---|
--list |
List all 3rd party libraries used in this project. | |
--library |
VALUE |
Name of the library to show license for. |
apigenie lint
Lint one or more OpenAPI, Swagger 2.0, AsyncAPI, Protobuf (.proto) or GraphQL (.graphql, .graphqls, .gql) files.
Reference: apigenie lint
apigenie lint [OPTIONS] FILES...
| Argument or option | Value | Description |
|---|---|---|
FILES |
Path to OpenAPI, Swagger 2.0, AsyncAPI, Protobuf (.proto) or GraphQL (.graphql, .graphqls, .gql) files to lint. Can be given more than once. | |
--config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
--ruleset |
FILE |
A Spectral ruleset file (YAML or JSON) that OpenAPI, AsyncAPI and Swagger documents are linted with, after the rulesets of the configuration’s ‘extends’; without a configuration, instead of the recommended ruleset. Can be repeated. Can be given more than once. |
--fix |
Automatically fixes problems where possible. | |
--bundle |
Bundles the local files an OpenAPI document references into it before linting, as apigenie bundle does, so that the rules check what the references lead to. Issues in bundled content are reported in the file they come from, at their line. Without it, the rules check what the file holds and skip references to other files. Applies to OpenAPI 3.x documents; can’t be combined with –fix. bundle: true in the lint configuration does the same on every run except with –fix. |
|
--strip-comments |
With –fix: drops the YAML comments of the OpenAPI, Swagger and AsyncAPI files it rewrites instead of keeping them. | |
--baseline |
FILE |
A baseline file of accepted findings, which are neither reported nor counted in the exit status. Default: the configuration’s baseline, else .apigenie.lint-ignore.yaml, or Redocly’s .redocly.lint-ignore.yaml, next to the configuration file (in the current directory without one). The run exits with 6 when no error is reported but the baseline has findings of the linted files that no longer occur. |
--generate-baseline |
Records the findings of the files in the baseline instead of reporting them, replacing the findings it had for these files and keeping those of other files. Writes .apigenie.lint-ignore.yaml when –baseline and the configuration name no file. | |
--no-baseline |
Reports every finding, without reading a baseline. | |
--new-since |
REV |
Reports only the findings the files didn’t have at the git revision REV (a branch, a tag or a commit, e.g. HEAD or main), and counts only those in the exit status; standard error gives the number of the others. Each file is linted as it was at REV, with the configuration of this run. A finding is the same when its rule and JSON pointer are, or its rule and message for Protobuf and GraphQL, so lines that move change nothing. A file that didn’t exist at REV has only new findings. For a pull request, compare with the merge base: –new-since “$(git merge-base origin/main HEAD)”. Can’t be combined with –fix or –generate-baseline. |
--git |
GIT |
Path to the git program that –new-since runs; ignored without it. |
--watch |
Re-runs linting when an input or configuration file changes. | |
--formatter |
VALUE |
Specifies the formatter |
--max-problems |
N |
Prints at most N findings, the most severe first: errors, then warnings, then hints, and within a severity by file, line and column. The exit status is that of the whole run, and when findings are left out, standard error gives their totals. Every file is reported at the end of the run. |
--output |
FILE |
Writes the report to FILE instead of standard output, also when errors fail the run. Refuses to replace a file the run read: an input, a file an input imports or references, the configuration, a ruleset, function or GraphQL schema file, or the baseline. Can’t be combined with –json or –generate-baseline. |
--proto-path |
DIR |
A directory in which the imports of .proto files are looked up, before the directories of the configuration and those above the importing file. Can be repeated. Can be given more than once. |
--graphql-schema |
FILE |
A GraphQL schema file the operations of .graphql files are checked against. Can be repeated; replaces the files of the ‘schema’ option of the configuration. Can be given more than once. |
apigenie overlay
Apply OpenAPI Overlays (versions 1.0, 1.1 and 1.2) to an OpenAPI document, or to any JSON or YAML document.
Reference: apigenie overlay
apigenie overlay [OPTIONS] [INPUT]
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the document to apply the overlays to. Required unless –validate is given. | |
--overlay |
OVERLAY |
Path to an overlay. Can be repeated: the overlays are applied in order. Required. Can be given more than once. |
-o, --output |
OUTPUT |
Path to the overlaid document. Defaults to standard output. |
--format |
FORMAT |
Output serialization format. Defaults to the input format. One of json, yaml. |
--validate |
Only checks the overlays, without applying them: INPUT is not needed. | |
--strip-comments |
Drops the comments of the document and of the overlays instead of keeping them. |
apigenie diff
Compares two OpenAPI, two Swagger, two AsyncAPI, two Protobuf (.proto) or two GraphQL (.graphql) files and prints the differences.
Reference: apigenie diff
apigenie diff [OPTIONS] source_file dest_file
| Argument or option | Value | Description |
|---|---|---|
source_file |
Path to the original OpenAPI, Swagger, AsyncAPI, Protobuf (.proto) or GraphQL (.graphql) file. | |
dest_file |
Path to the final OpenAPI, Swagger, AsyncAPI, Protobuf (.proto) or GraphQL (.graphql) file. | |
--config |
VALUE |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
--report |
VALUE |
Specifies what to print One of status, changelog, detailed. |
--formatter |
VALUE |
Specifies the formatter One of html, json, markdown, stylish, unix, visualstudio. |
--bundle |
Bundles the local files each OpenAPI document references into it before comparing, as apigenie bundle does, so that what the references lead to is compared; changes in bundled content have no position. Without it, a reference to another file is compared by its $ref. Applies to OpenAPI 3.x documents; can’t be combined with –update-version. |
|
--update-version |
Updates the version of the destination file to the minimal suggested version. | |
--today |
DATE |
The date of the comparison (YYYY-MM-DD) for the sunset_passed condition of the rules: a deprecated element whose x-sunset date is on or before it may go. Defaults to the current date. OpenAPI documents only. |
apigenie changelog
Prints the changelog of an OpenAPI, Swagger, AsyncAPI, Protobuf or GraphQL file, by comparing its versions in git history.
Reference: apigenie changelog
apigenie changelog [OPTIONS] spec_file
| Argument or option | Value | Description |
|---|---|---|
spec_file |
Path to the OpenAPI, Swagger, AsyncAPI, Protobuf or GraphQL file. | |
--revisions |
VALUE |
Compares every commit that changes the file, or every release tag. One of commits, tags. |
--tag-pattern |
VALUE |
Glob pattern of the release tags, e.g. ‘v*’. |
--tag-sort |
VALUE |
Orders the release tags by version numbers in their names, or by date. One of version, date. |
--unreleased |
With –revisions tags, adds the changes made after the last release. | |
--from |
VALUE |
The revision the changelog starts after, e.g. a tag. By default, the changelog starts with the first version of the file. |
--to |
VALUE |
The last revision. |
--path |
VALUE |
With –revisions commits, only commits that change these paths are compared. By default, the specification and the files it references in the last revision (Protobuf and GraphQL: the file only). Can be given more than once. |
--by |
VALUE |
Groups the changes by revision, or by operation. One of revision, operation. |
--operation |
VALUE |
Only shows the changes of an operation. OpenAPI and Swagger: ‘GET /pets’, a path or an operation id. AsyncAPI: ‘send user/signedup’, a channel address or an operation id. Protobuf: ‘Customers.GetCustomer’, a method name or a service name. GraphQL: ‘Query.users’, a field name, a root type name or ‘query’, ‘mutation’ or ‘subscription’. Can be repeated. Can be given more than once. |
--formatter |
VALUE |
Specifies the formatter One of html, json, markdown, stylish. |
--config |
VALUE |
Path to the configuration file; its ‘diff’ settings (‘diff.swagger’ for Swagger, ‘diff.asyncapi’ for AsyncAPI, ‘diff.protobuf’ for Protobuf, ‘diff.graphql’ for GraphQL) decide the severity of the changes. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
--git |
VALUE |
Path to the git program. |
-o, --output |
OUTPUT |
Path to the output file. By default, the changelog is printed. |
apigenie evolve
Plan safe API changes: ‘evolve plan’ splits the breaking changes between two OpenAPI documents into an expand wave (deprecate, add next to) and a contract wave (remove), writes the wave documents and the plan, and proves the plan with diff (experimental, outside the 1.0 compatibility promise).
Reference: apigenie evolve
apigenie evolve [OPTIONS] COMMAND
Commands: plan.
apigenie evolve plan
Write plan.yaml, 1-expand.yaml (the target with the old elements kept next to the new ones, deprecated with a sunset date) and 2-contract.yaml (the target) for the change from OLD_FILE to NEW_FILE, and report what the server has to do (experimental, outside the 1.0 compatibility promise).
Reference: apigenie evolve plan
apigenie evolve plan [OPTIONS] OLD_FILE NEW_FILE
| Argument or option | Value | Description |
|---|---|---|
OLD_FILE |
The OpenAPI document consumers use today. | |
NEW_FILE |
The OpenAPI document the change arrives at. | |
--hints |
FILE |
A YAML file with renames the diff can’t see ({from, to} as METHOD /path or locations), the window and the reason of the change. |
--window |
WINDOW |
How long consumers have to move before the contract wave: days (90d) or weeks (12w). The hints file’s window applies when this is not given. |
--today |
DATE |
The date the plan is made at (YYYY-MM-DD); the sunset dates are today plus the window. Defaults to the current date. |
--config |
CONFIG |
Path to the configuration file; its commands.diff block rates the changes. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
--out |
DIR |
The directory the plan and the wave documents are written to. |
--format |
FORMAT |
The report: text or json. One of text, json. |
apigenie i18n
Extract the texts of an API description for translation, check and update translations of them, or apply them to it.
Reference: apigenie i18n
apigenie i18n [OPTIONS] COMMAND
Commands: extract, apply, check, sync.
apigenie i18n extract
Extract i18n data from an OpenAPI, Swagger 2.0 or AsyncAPI spec, or from a Protobuf or GraphQL file.
Reference: apigenie i18n extract
apigenie i18n extract [OPTIONS] FILE
| Argument or option | Value | Description |
|---|---|---|
FILE |
Path to OpenAPI, Swagger 2.0, AsyncAPI, Protobuf (.proto) or GraphQL (.graphql, .graphqls, .gql) file to process. | |
-o, --output |
DEST |
Path to extracted i18n literals (.json or .yaml). Nothing is written without it. |
apigenie i18n apply
Apply translations, keyed as ‘i18n extract’ writes them, to an OpenAPI, Swagger 2.0 or AsyncAPI spec, or to a Protobuf or GraphQL file: the text each key addresses (a string, a leading comment or a description) is replaced by its translation, and everything else, comments included, is kept.
Reference: apigenie i18n apply
apigenie i18n apply [OPTIONS] FILE
| Argument or option | Value | Description |
|---|---|---|
FILE |
Path to the OpenAPI, Swagger 2.0 or AsyncAPI spec (JSON or YAML), Protobuf (.proto) or GraphQL (.graphql, .graphqls, .gql) file to translate. | |
--translations |
TRANSLATIONS |
Path to a translation file (.json or .yaml). Can be repeated: later files override earlier ones. Required. Can be given more than once. |
-o, --output |
OUTPUT |
Path to the translated spec. Defaults to standard output. |
--format |
FORMAT |
Output serialization format of a JSON or YAML spec. Defaults to the input format. One of json, yaml. |
--strict |
Fail when a key of a translation file addresses nothing in the file. | |
--strip-comments |
Drops the comments of the file instead of keeping them: the YAML comments of a spec, the ‘#’ comments of a GraphQL file (descriptions are kept). Not available for Protobuf files, whose comments are the translated texts. |
apigenie i18n check
Check a translation file against the texts of an API description: report the texts without a translation and the keys that aren’t texts, and the share of texts translated. Fails unless every text is translated and nothing else is.
Reference: apigenie i18n check
apigenie i18n check [OPTIONS] FILE
| Argument or option | Value | Description |
|---|---|---|
FILE |
Path to the texts: an OpenAPI, Swagger 2.0 or AsyncAPI spec, a Protobuf or GraphQL file, or the output of ‘i18n extract’. | |
--translations |
TRANSLATIONS |
Path to the translation file (.json or .yaml) to check. Required. |
--allow-empty |
Count empty translations as translated, instead of missing. | |
--format |
FORMAT |
Output format of the report: text (default), or json on the standard output. One of text, json. |
apigenie i18n sync
Update a translation file after the API description changed: keep the translations of unchanged texts, report the new texts, the texts that changed (their translations may be stale) and the removed ones. Texts are matched by key: a moved text is removed and added.
Reference: apigenie i18n sync
apigenie i18n sync [OPTIONS] FILE
| Argument or option | Value | Description |
|---|---|---|
FILE |
Path to the current texts: an OpenAPI, Swagger 2.0 or AsyncAPI spec, a Protobuf or GraphQL file, or the output of ‘i18n extract’. | |
--previous |
PREVIOUS |
Path to the texts the translations were made from: a spec, Protobuf or GraphQL file, or the output of ‘i18n extract’. Required. |
--translations |
TRANSLATIONS |
Path to the translation file (.json or .yaml) to update. Required. |
-o, --output |
OUTPUT |
Path to the updated translation file. Defaults to standard output. |
--prune |
Drop the translations of the removed texts instead of keeping them. | |
--drop-changed |
Drop the translations of the texts that changed, so that they show as missing. |
apigenie init
Set a repository up for API Genie and for coding agents: write apigenie.yaml with the lint rules of the API descriptions found in it, and add the section that tells coding agents how to check them to AGENTS.md. Files that are there already are kept; AGENTS.md gets the section appended when it lacks one.
Reference: apigenie init
apigenie init [OPTIONS] [DIR]
| Argument or option | Value | Description |
|---|---|---|
DIR |
The repository: the directory of the configuration file the other commands read here, else the root of the git repository holding this directory, else the directory itself. Defaults to the current directory. | |
--ruleset |
VALUE |
The ruleset the linter extends for every family of API descriptions. One of recommended, strict, all. |
--agents-file |
FILE |
The instructions file of the coding agents, relative to the repository: e.g. CLAUDE.md or .github/copilot-instructions.md. |
--no-agents |
Leave the instructions of the coding agents alone. | |
--dry-run |
Print what would be written, and write nothing. | |
--git |
VALUE |
Path to the git program, which finds the repository and the files it ignores. |
apigenie test
Run the requests of .http files (the httpYac flavour: HTTP, GRAPHQL, GRPC, WS and MQTT) and requests generated from an OpenAPI or AsyncAPI document, a GraphQL schema or a .proto file against a live server, check their assertions, and validate every request, response and message against the document or the schema.
Reference: apigenie test
apigenie test [OPTIONS] COMMAND [FILES...]
| Argument or option | Value | Description |
|---|---|---|
FILES |
.http and .rest files, or directories to search for them. | |
--spec |
SPEC |
The OpenAPI 3.x document HTTP requests and responses are validated against, the GraphQL schema (.graphql, .graphqls, .gql) of GraphQL requests, the .proto file of GRPC requests, or the AsyncAPI 3.x document WS and MQTT messages and the requests of its HTTP channels are validated against. |
--proto-path |
DIR |
A directory in which the imports of a .proto –spec are looked up, before the directory of the file. Can be repeated. Can be given more than once. |
--generate |
Also send one request per operation of –spec (per root field of a GraphQL schema, per method of a .proto file), from its examples or values generated from its schemas. | |
--base-url |
URL |
The server’s URL: replaces the document’s servers for –generate, and is put before request URLs that start with ‘/’. HOST:PORT (or grpc://, grpcs:// for TLS) for a .proto file, the endpoint for a GraphQL schema, ws:// (or http://) for an AsyncAPI document’s WebSocket and HTTP channels. |
--mqtt-url |
URL |
The MQTT broker (mqtt://host:port) of an AsyncAPI document’s MQTT channels for –generate. |
--amqp-url |
URL |
The AMQP 0-9-1 broker (amqp://host:port/vhost, amqps:// over TLS) of an AsyncAPI document’s AMQP channels for –generate. |
--kafka-url |
URL |
A broker of the Kafka cluster (kafka://host:port, kafkas:// over TLS) of an AsyncAPI document’s Kafka channels for –generate. |
--env |
NAME |
The environment of http-client.env.json and .env.NAME files. |
--env-file |
FILE |
An environment file to read after the others: JSON like http-client.env.json, or KEY=VALUE lines like .env. Can be repeated. Can be given more than once. |
--var |
NAME=VALUE |
A variable that overrides every other one. Can be repeated. Can be given more than once. |
--data |
FILE |
A CSV file (a header line of column names, then a row per line) or a JSON array of objects: the requests run once per row, without the variables the scripts of the row before set; a row’s values are variables that only –var overrides, and reports name the row of each request. |
--header |
NAME:VALUE |
A header for every request that doesn’t have it. Can be repeated. Can be given more than once. |
--timeout |
MS |
How long to wait for a connection and for a response, in milliseconds (default 30000). |
--message-timeout |
MS |
How long WS and MQTT requests, GraphQL subscriptions and gRPC client and bidi streams wait for messages, in milliseconds (default 5000); # @timeout overrides it. |
--bail |
Stop at the first failed request, and run no more rows of –data. | |
--ca-cert |
FILE |
A PEM file of certificate authorities trusted for https://, grpcs://, wss:// and mqtts:// URLs, besides the system’s. Can be repeated. Can be given more than once. |
--insecure |
Don’t verify the certificates of https://, grpcs://, wss:// and mqtts:// servers; the traffic stays encrypted. | |
--client-cert |
FILE |
A PEM client certificate (chain) presented to https://, grpcs://, wss:// and mqtts:// servers that ask for one (mTLS); needs –client-key. |
--client-key |
FILE |
The unencrypted PEM private key of –client-cert. |
--report |
FILE |
Write the report (requests, coverage and violations) as JSON to FILE. |
--report-junit |
FILE |
Write the report as JUnit XML to FILE. |
--redact-header |
NAME |
Show the values of this header, in the requests sent and the responses received, as [redacted] in the output and the reports. Can be repeated. Can be given more than once. |
--redact-body |
`request | response |
--fail-on |
`none | errors |
--min-coverage |
PERCENT |
Fail the run when less than PERCENT of the document’s operations, request bodies and responses (a GraphQL schema’s fields, a .proto file’s methods, an AsyncAPI document’s operations’ messages) were exercised. |
--severity |
CHECK=LEVEL |
Change the severity of a contract check: CHECK=error|warn|info|off. Can be repeated. Can be given more than once. |
--seed |
N |
Seed of the values –generate makes up, for repeatable runs. |
--formatter |
`stylish | json` |
--quiet |
Show only failed requests and the summary. | |
--verbose |
Also show warnings and notes of the contract checks, and the scripts’ log. |
Commands: import, keychain, secrets, sync.
apigenie test import
Import a Postman collection (v2.0 or v2.1), an Insomnia export (format 4 or a v5 collection file) or a HAR file into runnable .http files.
Reference: apigenie test import
apigenie test import [OPTIONS] [COLLECTION]
| Argument or option | Value | Description |
|---|---|---|
COLLECTION |
The Postman collection, Insomnia export or HAR file. | |
-o, --output |
DIR |
Output directory for request files, environments and upload assets. |
--environment |
FILE |
A Postman environment JSON export. Can be repeated. Can be given more than once. |
--spec |
SPEC |
Bind requests to this OpenAPI document and emit saved examples as an overlay. |
--force |
Replace existing generated files; leave unrelated files untouched. |
apigenie test keychain
Store or remove a secret of the OS keychain (the macOS Keychain, the Windows Credential Manager, or the Secret Service through secret-tool on Linux), which request files and environment files read with {{$secret NAME}} instead of keeping it in a file. ‘set’ reads the secret from the terminal without showing it, or from standard input.
Reference: apigenie test keychain
apigenie test keychain [OPTIONS] ACTION NAME
| Argument or option | Value | Description |
|---|---|---|
ACTION |
set: store the secret, replacing the one there; delete: remove it. One of set, delete. |
|
NAME |
The NAME of {{$secret NAME}}: letters, digits, ‘.’, ‘_’, ‘-’ and ‘/’, starting with a letter or a digit. |
apigenie test secrets
Find the secrets of .http files that a commit would carry: credentials (Authorization headers, API keys, OAuth 2 client secrets and passwords) written in a request file, or taken from its @name = value lines or from http-client.env.json. With –fix, move them to http-client.private.env.json and point the request file to them with {{name}}. Exit status 1 when one is found (and, with –fix, could not be moved).
Reference: apigenie test secrets
apigenie test secrets [OPTIONS] FILES...
| Argument or option | Value | Description |
|---|---|---|
FILES |
.http and .rest files, or directories to search for them. | |
--env |
NAME |
The environment of http-client.env.json and .env.NAME files, as for a run. |
--env-file |
FILE |
An environment file to read after the others, as for a run. Can be repeated. Can be given more than once. |
--fix |
Move the secrets to http-client.private.env.json, next to the environment files the requests use (or the request file). |
apigenie test sync
Check the requests of .http files that # @operation binds to an OpenAPI document against it: which are in sync, which drifted (method, path, query and header parameters, JSON body), which are bound to an operation that is gone, which are bound to none, and which operations have no request yet. With –write, merge the document into each drifted request, keeping the user’s values and {{variables}}, and keep the document in http-sync-base.json as the base of the next merge. Exit status 1 when a request drifted (with –write, when one could not be merged).
Reference: apigenie test sync
apigenie test sync [OPTIONS] FILES...
| Argument or option | Value | Description |
|---|---|---|
FILES |
.http and .rest files, or directories to search for them. | |
--spec |
SPEC |
The OpenAPI 3.x or Swagger 2.0 document the requests are bound to. Required. |
--base |
FILE |
The file the merge base is kept in: the document the requests were last in step with. Default: http-sync-base.json in the first directory of FILES (else next to the first file). |
--base-rev |
REV |
Take the merge base from a git revision of –spec (a commit, a branch, a tag) instead of –base. |
--write |
Merge the document into the request files, and keep it in –base for the next merge. |
apigenie run
Run a script of the configuration file (apigenie.yaml found in the current directory or a parent up to the root of the repository, or –config): a named command line of apigenie from its ‘scripts’ section, run from the directory of the file, with the arguments after NAME added at the end. Without NAME, list the scripts. Exits with the exit status of the script’s command.
Reference: apigenie run
apigenie run [OPTIONS] [NAME [ARGS...]...]
| Argument or option | Value | Description |
|---|---|---|
NAME [ARGS...] |
The name of the script, then the arguments added to its command line, options included. | |
--config |
CONFIG |
Path to the configuration file; replaces the one found in the repository. To run a script, it must be the file that the script’s command finds from the file’s directory. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. |
apigenie commands
Lists every command of the binary. With –json, prints every command with its arguments and options, as data for scripts and coding agents.
apigenie commands [OPTIONS]
apigenie completion
Prints the script that completes the commands, options and option values of apigenie in a shell. Load it in the shell’s startup file, for example eval "$(apigenie completion bash)" in ~/.bashrc.
Reference: apigenie completion
apigenie completion [OPTIONS] SHELL
| Argument or option | Value | Description |
|---|---|---|
SHELL |
The shell: bash, zsh, fish or powershell. One of bash, zsh, fish, powershell. |
apigenie-generator
Generate code and data from an OpenAPI or AsyncAPI file, servers from a GraphQL schema, documentation sites from OpenAPI, Swagger, AsyncAPI, GraphQL and Protobuf files, and validation schemas from JSON Schemas.
apigenie-generator [OPTIONS] COMMAND
| Argument or option | Value | Description |
|---|---|---|
-h, --help |
shows help message and exits | |
-v, --version |
prints the version (and those of apigenie, apigenie-generator, apigenie-server and apigenie-catalog installed next to it) and exits | |
--credits |
Show the 3rd party libraries API Genie uses, and exit. | |
--license |
LIBRARY |
Show the license of API Genie, or of the named 3rd party library, and exit. |
--license-list |
List the 3rd party libraries with their licenses, and exit. |
Commands: data, docs, client, server, schema, search, commands, completion.
apigenie-generator data
Generate data from an OpenAPI file.
Reference: apigenie-generator data
apigenie-generator data [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI spec. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-p, --pointer |
POINTER |
JSON Pointer to the schema, e.g. /components/schemas/User. Required. |
-o, --output |
OUTPUT |
Path to the output file. The format is inferred from the file extension. Required. |
-n, --number |
NUMBER |
Number of items to generate. If greater than 1, an array is generated. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. |
apigenie-generator docs
Generate a documentation site from OpenAPI, Swagger 2.0, AsyncAPI, GraphQL and Protobuf files: a docs bundle for the API Genie web components, and the npm project that prerenders it to static HTML (npm install && npm run build).
Reference: apigenie-generator docs
apigenie-generator docs [OPTIONS] INPUT...
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Paths to the API descriptions: OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x (JSON or YAML), GraphQL (.graphql, .graphqls, .gql) or Protobuf (.proto). May be left out when the configuration file lists the documents. Can be given more than once. | |
-c, --config |
CONFIG |
Path to the configuration file; its ‘commands.generate.docs’ section configures the site, its ‘diff’ section the severities of the changelog. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--i18n |
LOCALE=FILE |
Translations of the inputs as ‘locale=filename’, as ‘i18n extract’ writes them. Can be repeated. Can be given more than once. |
--changelog |
Adds the changelog of each input from its git history, as ‘apigenie changelog’ computes it. | |
--package-name |
PACKAGE_NAME |
Name of the generated npm package. |
--package-version |
PACKAGE_VERSION |
Version of the generated npm package. |
--bundle-only |
Writes the docs bundle only, without package.json and README.md. |
apigenie-generator client
Generate a client from an OpenAPI or AsyncAPI file.
apigenie-generator client [OPTIONS] COMMAND
Commands: fetch, elixir, go, java, python, rust, swift, csharp, ws, kafkajs.
apigenie-generator client fetch
Generate a TypeScript client using the fetch API.
Reference: apigenie-generator client fetch
apigenie-generator client fetch [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client elixir
Generate an Elixir client on Req from an OpenAPI file: a Mix project with a module per tag and a function per operation returning {:ok, body} or {:error, %ApiError{}}, model structs, parameters encoded in their styles, form and multipart bodies. From a .proto file, a gRPC client on elixir-grpc: the protobuf-elixir modules of the messages and a module per service with a function per method, streams as enumerables. From an AsyncAPI 3.x file: a library connecting to the WebSocket channels on Mint.WebSocket, with senders and consumer groups on brod for the Kafka operations.
Reference: apigenie-generator client elixir
apigenie-generator client elixir [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file, or to the .proto file (with the files it imports). | |
-I, --proto-path |
DIR |
Directory searched for the files a .proto file imports, like protoc’s –proto_path; the file’s own directory is searched last. Can be repeated. Can be given more than once. |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Mix application, converted to snake_case (its root module is the PascalCase name); by default the name of the output directory (OpenAPI) or the document’s title (AsyncAPI). |
--package-version |
PACKAGE_VERSION |
Version of the Mix project; 0.1.0 by default. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. dev_deps=false. Can be repeated. OpenAPI only. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client go
Generate a Go client (net/http of Go 1.22) from an OpenAPI file, with typed responses by status, streams, multipart uploads and validation (the standard library only), or a Go Kafka client package on franz-go from an AsyncAPI 3.x file.
Reference: apigenie-generator client go
apigenie-generator client go [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Go package; by default the name of the output directory (OpenAPI) or the document’s title (AsyncAPI). |
--package-version |
PACKAGE_VERSION |
Ignored: Go packages have no version. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. layout=module. Can be repeated. OpenAPI only. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client java
Generate a Java client from an OpenAPI file: a Maven project using Spring’s RestClient (the default) or RestTemplate, Spring Cloud OpenFeign or Spring HTTP interfaces; or a Java 21 Kafka client library on the Apache Kafka client from an AsyncAPI 3.x file.
Reference: apigenie-generator client java
apigenie-generator client java [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Base package of the generated code, e.g. com.example.client. The api and model packages are derived from it unless set explicitly. AsyncAPI: the artifact id, by default the document’s title followed by -client. |
--package-version |
PACKAGE_VERSION |
Version of the generated artifact. |
--library |
LIBRARY |
HTTP library of the client: restclient (Spring RestClient, the default), resttemplate, feign (Spring Cloud OpenFeign) or http-interface (Spring HTTP interfaces). OpenAPI only. One of restclient, resttemplate, feign, http-interface. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. useBeanValidation=false. Can be repeated. OpenAPI only. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client python
Generate a Python client using httpx and Pydantic from an OpenAPI file, or an asyncio Kafka client package on aiokafka from an AsyncAPI 3.x file.
Reference: apigenie-generator client python
apigenie-generator client python [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated distribution, e.g. my-api-client. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client rust
Generate a Rust client crate (reqwest and serde, async on tokio) from an OpenAPI file: an async method per operation returning an enum of the documented responses, the types of the schemas with validation, streams and multipart uploads (experimental, outside the 1.0 compatibility promise).
Reference: apigenie-generator client rust
apigenie-generator client rust [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the crate; by default the name of the output directory. |
--package-version |
PACKAGE_VERSION |
Version of the crate; by default the document’s info.version. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. internal_operations=exclude. Can be repeated. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client swift
Generate a Swift package calling an OpenAPI API: an async/await client on URLSession behind an HTTPTransport protocol, with a response enum per operation, Codable and Sendable models that check their schemas, streams and multipart uploads, and no dependencies (experimental, outside the 1.0 compatibility promise).
Reference: apigenie-generator client swift
apigenie-generator client swift [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Swift module, its product and the package; by default the document’s title followed by Client. |
--package-version |
PACKAGE_VERSION |
Ignored: Swift packages take their versions from Git tags. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. validate_responses=true. Can be repeated. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client csharp
Generate a C# client (HttpClient, System.Text.Json, .NET 8) from an OpenAPI file, or a C# Kafka client library on Confluent.Kafka from an AsyncAPI 3.x file.
Reference: apigenie-generator client csharp
apigenie-generator client csharp [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Root namespace of the generated code, e.g. Acme.PetStore.Client. Defaults to the title of the API followed by .Client. |
--package-version |
PACKAGE_VERSION |
Version of the generated project. Defaults to the version of the API. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. layout=sources. Can be repeated. OpenAPI only. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client ws
Generate a TypeScript client of the WebSocket channels of an AsyncAPI file.
Reference: apigenie-generator client ws
apigenie-generator client ws [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator client kafkajs
Generate a TypeScript (Node.js) client of the Kafka channels of an AsyncAPI file, on KafkaJS.
Reference: apigenie-generator client kafkajs
apigenie-generator client kafkajs [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server
Generate server code from an OpenAPI or AsyncAPI file, or a GraphQL schema.
apigenie-generator server [OPTIONS] COMMAND
Commands: absinthe, axum, express, fastapi, go, hummingbird, phoenix, elixir-grpc, mcp, orpc, spring, vapor, aspnet, ws, kafkajs, faststream.
apigenie-generator server absinthe
Generate an Absinthe server from a GraphQL schema (SDL): a schema module importing the SDL, a resolver behaviour per object type with root fields or fields with arguments, the resolution of interfaces and unions, custom scalars, and a Plug router with Absinthe.Plug and GraphiQL.
Reference: apigenie-generator server absinthe
apigenie-generator server absinthe [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the GraphQL schema (.graphql, .graphqls or .gql). | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Mix application, converted to snake_case (its root module is the PascalCase name); by default the name of the output directory. |
--package-version |
PACKAGE_VERSION |
Version of the Mix project; 0.1.0 by default. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. dataloader=true. Can be repeated. Can be given more than once. |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server axum
Generate a Rust server crate on axum from an OpenAPI file: an Api trait with an async method per operation, a router that decodes and validates requests (400 with problem details) and checks security before calling it, and response enums written as the document describes them (experimental, outside the 1.0 compatibility promise).
Reference: apigenie-generator server axum
apigenie-generator server axum [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the crate; by default the name of the output directory. |
--package-version |
PACKAGE_VERSION |
Version of the crate; by default the document’s info.version. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. internal_operations=exclude. Can be repeated. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server express
Generate a TypeScript Express server from an OpenAPI file: typed handler interfaces and a router decoding, validating and authenticating requests.
Reference: apigenie-generator server express
apigenie-generator server express [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server fastapi
Generate a Python FastAPI server from an OpenAPI file: pydantic models, a router and a base class to implement per API, and the dependencies checking credentials. The project has the layout of the ‘python-fastapi’ generator of OpenAPI Generator.
Reference: apigenie-generator server fastapi
apigenie-generator server fastapi [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Python package of the generated code, e.g. pet_store. |
--package-version |
PACKAGE_VERSION |
Version of the generated project. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. serverPort=8000. Can be repeated. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server go
Generate a Go server (net/http ServeMux of Go 1.22) from an OpenAPI file, with types, parameter binding, validation and a strict server interface (the standard library only), or a Go Kafka application on franz-go from an AsyncAPI 3.x file.
Reference: apigenie-generator server go
apigenie-generator server go [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Go package; by default the name of the output directory (OpenAPI) or the document’s title (AsyncAPI). |
--package-version |
PACKAGE_VERSION |
Ignored: Go packages have no version. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. layout=module. Can be repeated. OpenAPI only. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server hummingbird
Generate a Swift server package on Hummingbird 2 from an OpenAPI file: an APIHandler protocol with an async method per operation, routes that decode and validate requests before it runs, Codable and Sendable models, and senders of webhooks and callbacks (experimental, outside the 1.0 compatibility promise).
Reference: apigenie-generator server hummingbird
apigenie-generator server hummingbird [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Swift module, its product and the package; by default the document’s title followed by Server. |
--package-version |
PACKAGE_VERSION |
Ignored: Swift packages take their versions from Git tags. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. internal_operations=true. Can be repeated. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server phoenix
Generate a Phoenix 1.7 application from an OpenAPI file: a router, a controller and a behaviour per tag whose callbacks receive decoded parameters and bodies, model structs, and plugs checking credentials; requests that don’t match the description get 400. From an AsyncAPI 3.x file: Phoenix channels for the WebSocket channels, Broadway pipelines and brod senders for the Kafka operations.
Reference: apigenie-generator server phoenix
apigenie-generator server phoenix [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Mix application, converted to snake_case (its root module is the PascalCase name, the web modules are in <Root>Web); by default the name of the output directory (OpenAPI) or the document’s title (AsyncAPI). |
--package-version |
PACKAGE_VERSION |
Version of the Mix project; 0.1.0 by default. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. base_path=/api. Can be repeated. OpenAPI only. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server elixir-grpc
Generate an Elixir gRPC server on elixir-grpc from a .proto file and the files it imports: the protobuf-elixir modules of the messages, a behaviour per service with a callback per method (streams as enumerables), the endpoint and the application.
Reference: apigenie-generator server elixir-grpc
apigenie-generator server elixir-grpc [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the .proto file declaring the services. | |
-I, --proto-path |
DIR |
Directory searched for the files a .proto file imports, like protoc’s –proto_path; the file’s own directory is searched last. Can be repeated. Can be given more than once. |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Mix application, converted to snake_case (its root module is the PascalCase name); by default the name of the output directory. |
--package-version |
PACKAGE_VERSION |
Version of the Mix project; 0.1.0 by default. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. package_prefix=acme.proto. Can be repeated. Can be given more than once. |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server mcp
Generate a Model Context Protocol server in TypeScript from an OpenAPI file: a tool per operation, calling the API through a generated fetch client (experimental, outside the 1.0 compatibility promise).
Reference: apigenie-generator server mcp
apigenie-generator server mcp [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package, which also names the MCP server. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--mock |
Point the tools at apigenie-server mocking the API by default, for demos: adds openapi.json and npm run mock. |
|
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server orpc
Generate a TypeScript server based on oRPC from an OpenAPI file: Zod schemas, an oRPC contract, handler stubs and a Node.js HTTP server.
Reference: apigenie-generator server orpc
apigenie-generator server orpc [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server spring
Generate a Spring Boot server from an OpenAPI file, equivalent to the output of the ‘spring’ generator of OpenAPI Generator, or a Spring Boot Kafka application from an AsyncAPI 3.x file.
Reference: apigenie-generator server spring
apigenie-generator server spring [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
OpenAPI: base package of the generated code, e.g. com.example. The api, model and configuration packages are derived from it unless set explicitly. AsyncAPI: the Maven artifact id. |
--package-version |
PACKAGE_VERSION |
Version of the generated artifact. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. delegatePattern=true. Can be repeated. OpenAPI only. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server vapor
Generate a Swift server package on Vapor 4 from an OpenAPI file: an APIHandler protocol with an async method per operation, routes that decode and validate requests before it runs, Codable and Sendable models, and senders of webhooks and callbacks (experimental, outside the 1.0 compatibility promise).
Reference: apigenie-generator server vapor
apigenie-generator server vapor [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x or Swagger 2.0 file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the Swift module, its product and the package; by default the document’s title followed by Server. |
--package-version |
PACKAGE_VERSION |
Ignored: Swift packages take their versions from Git tags. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. internal_operations=true. Can be repeated. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server aspnet
Generate an ASP.NET Core server (Minimal APIs, C#) from an OpenAPI file, or an ASP.NET Core application consuming the Kafka channels of an AsyncAPI 3.x file on Confluent.Kafka.
Reference: apigenie-generator server aspnet
apigenie-generator server aspnet [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the OpenAPI 3.x, Swagger 2.0 or AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Root namespace of the generated code, e.g. Acme.PetStore. Defaults to the title of the API. |
--package-version |
PACKAGE_VERSION |
Version of the generated project. Defaults to the version of the API. |
-p, --property |
NAME=VALUE |
Generator option as ‘name=value’, e.g. layout=sources. Can be repeated. Can be given more than once. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server ws
Generate a TypeScript (Node.js) server of the WebSocket channels of an AsyncAPI file.
Reference: apigenie-generator server ws
apigenie-generator server ws [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server kafkajs
Generate a TypeScript (Node.js) application of the Kafka channels of an AsyncAPI file, on KafkaJS.
Reference: apigenie-generator server kafkajs
apigenie-generator server kafkajs [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator server faststream
Generate a Python FastStream application of the Kafka, AMQP (RabbitMQ) and MQTT channels of an AsyncAPI file.
Reference: apigenie-generator server faststream
apigenie-generator server faststream [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to the AsyncAPI 3.x file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator schema
Generate validation schemas from JSON Schemas.
apigenie-generator schema [OPTIONS] COMMAND
Commands: zod.
apigenie-generator schema zod
Generate Zod (v4) schemas, with their TypeScript types, from the root schema and the definitions of a JSON Schema file, or from the component schemas of an OpenAPI, Swagger or AsyncAPI file (experimental, outside the 1.0 compatibility promise).
Reference: apigenie-generator schema zod
apigenie-generator schema zod [OPTIONS] INPUT
| Argument or option | Value | Description |
|---|---|---|
INPUT |
Path to a JSON Schema, OpenAPI, Swagger or AsyncAPI file. | |
-c, --config |
CONFIG |
Path to the configuration file. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. | |
-o, --output |
OUTPUT |
Path to the output directory. Required. |
--package-name |
PACKAGE_NAME |
Name of the generated package. |
--package-version |
PACKAGE_VERSION |
Version of the generated package. |
--overlay |
OVERLAY |
Path to an OpenAPI Overlay (1.0 to 1.2) applied to the input before generating. Can be repeated: the overlays are applied in order, after those of the configuration file. Can be given more than once. |
--strict |
An overlay action whose target selects nothing is an error, not a warning. | |
--check |
Checks that the output directory holds what the generator would write, without writing anything: prints the files that would be created or changed, and exits with 1 when there are any. Files the generator doesn’t write are not compared. |
apigenie-generator search
Searches the code generators, those built in and those shipped as plugins, by the words of their command, language, framework and standard, e.g. search java quarkus. Reads the index published on the website (https://api-genie.dev/plugins/generators.json), keeps a copy for searches without the network, and falls back to the index of this release.
Reference: apigenie-generator search
apigenie-generator search [OPTIONS] WORDS...
| Argument or option | Value | Description |
|---|---|---|
WORDS |
The words to search for; a generator matches when it matches every word. | |
--offline |
Doesn’t connect to the website: searches the copy of the index kept by the last search, or the index of this release. |
apigenie-generator commands
Lists every command of the binary. With –json, prints every command with its arguments and options, as data for scripts and coding agents.
apigenie-generator commands [OPTIONS]
apigenie-generator completion
Prints the script that completes the commands, options and option values of apigenie-generator in a shell. Load it in the shell’s startup file, for example eval "$(apigenie-generator completion bash)" in ~/.bashrc.
Reference: apigenie-generator completion
apigenie-generator completion [OPTIONS] SHELL
| Argument or option | Value | Description |
|---|---|---|
SHELL |
The shell: bash, zsh, fish or powershell. One of bash, zsh, fish, powershell. |
apigenie-catalog
The API catalog of a repository (experimental, outside the 1.0 compatibility promise): ‘list’ lists its OpenAPI, AsyncAPI, Swagger, Protobuf and GraphQL specifications, ‘init’ writes the catalog section of apigenie.yaml, ‘versions’ lists the releases of a specification from its git tags and ‘release’ tags a new one.
apigenie-catalog [OPTIONS] COMMAND
| Argument or option | Value | Description |
|---|---|---|
-h, --help |
shows help message and exits | |
-v, --version |
prints the version (and those of apigenie, apigenie-generator, apigenie-server and apigenie-catalog installed next to it) and exits | |
--credits |
Show the 3rd party libraries API Genie uses, and exit. | |
--license |
LIBRARY |
Show the license of API Genie, or of the named 3rd party library, and exit. |
--license-list |
List the 3rd party libraries with their licenses, and exit. |
Commands: list, init, versions, release, commands, completion.
apigenie-catalog list
List the specifications of the repository: the files git tracks or does not ignore (all files outside a git repository) holding an OpenAPI, AsyncAPI or Swagger document, a Protobuf file or a GraphQL schema, except those matching catalog.exclude. Each has a name (from the catalog section, info.title, the Protobuf package or the file name), its format and version, its path and the last commit changing it.
Reference: apigenie-catalog list
apigenie-catalog list [OPTIONS] [DIR]
| Argument or option | Value | Description |
|---|---|---|
DIR |
Directory to look for specifications in. Defaults to the current directory. | |
--config |
CONFIG |
Path to the configuration file; replaces the one found in the repository. |
--git |
VALUE |
Path to the git program. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. |
apigenie-catalog init
Write the catalog section of the configuration file (apigenie.yaml, created at the root of the repository when there is none) from the specifications ‘list’ finds: one entry per specification with its name, path and owner. Running it again adds the new specifications, keeps the entries as they were edited and reports those whose files are gone.
Reference: apigenie-catalog init
apigenie-catalog init [OPTIONS] [DIR]
| Argument or option | Value | Description |
|---|---|---|
DIR |
Directory to look for specifications in. Defaults to the current directory. | |
--config |
CONFIG |
Path to the configuration file; replaces the one found in the repository. |
--git |
VALUE |
Path to the git program. |
--prune |
Remove the entries whose files are gone. | |
--dry-run |
Print the configuration file instead of writing it. |
apigenie-catalog versions
List the releases of a specification: the git tags matching catalog.tags.pattern ({name}-{version} by default) for its name, newest first, with the commit each points at. A tag that holds no semantic version where {version} stands is not a release.
Reference: apigenie-catalog versions
apigenie-catalog versions [OPTIONS] NAME
| Argument or option | Value | Description |
|---|---|---|
NAME |
The name of the specification, as ‘list’ prints it. | |
--config |
CONFIG |
Path to the configuration file; replaces the one found in the repository. |
--git |
VALUE |
Path to the git program. |
--no-config |
Don’t look for apigenie.yaml (or .apigenie.yaml) in the current directory and its parents up to the root of the repository. |
apigenie-catalog release
Release a specification: create the annotated tag catalog.tags.pattern names ({name}-{version} by default) at HEAD, once the version is a semantic version above the latest release, the tag is free, the file is committed, its info.version is the version and the specification is not retired. Nothing is pushed unless –push is given.
Reference: apigenie-catalog release
apigenie-catalog release [OPTIONS] NAME VERSION
| Argument or option | Value | Description |
|---|---|---|
NAME |
The name of the specification, as ‘list’ prints it. | |
VERSION |
The version to release: MAJOR.MINOR.PATCH, with an optional pre-release such as 1.4.0-rc.1. | |
--config |
CONFIG |
Path to the configuration file; replaces the one found in the repository. |
--git |
VALUE |
Path to the git program. |
--message |
MESSAGE |
The message of the annotated tag. Defaults to ‘NAME VERSION’. |
--push |
Push the tag to the remote after creating it. | |
--remote |
REMOTE |
The remote –push pushes to. |
--dry-run |
Run the checks and print the tag that would be created, without creating it. |
apigenie-catalog commands
Lists every command of the binary. With –json, prints every command with its arguments and options, as data for scripts and coding agents.
apigenie-catalog commands [OPTIONS]
apigenie-catalog completion
Prints the script that completes the commands, options and option values of apigenie-catalog in a shell. Load it in the shell’s startup file, for example eval "$(apigenie-catalog completion bash)" in ~/.bashrc.
Reference: apigenie-catalog completion
apigenie-catalog completion [OPTIONS] SHELL
| Argument or option | Value | Description |
|---|---|---|
SHELL |
The shell: bash, zsh, fish or powershell. One of bash, zsh, fish, powershell. |
See also
- completion: Completion of the commands and options in bash, zsh, fish and PowerShell, written from the same lists.
- JSON output:
--jsonon every command.