Commands

apigenie is the API Genie command-line interface. Each command works on one or more API descriptions: OpenAPI, Swagger 2.0, AsyncAPI, Protobuf or GraphQL files.

Usage

apigenie COMMAND [OPTIONS] [FILES]

Commands

Name	Summary
apigenie bundle	bundles an OpenAPI, Swagger or AsyncAPI spec, or a Protobuf file, into one file
apigenie changelog	builds the changelog of an OpenAPI, Swagger or AsyncAPI spec, or of a Protobuf or GraphQL file, from Git history
apigenie config	prints the effective configuration, checks a configuration file and prints its JSON Schema
apigenie convert	converts a Swagger 2.0 spec to OpenAPI 3.2, a WSDL 1.1 one to OpenAPI 3.1, or a JSON Schema to an older dialect
apigenie credits	shows credits for 3rd party dependencies
apigenie diff	compares two versions of an OpenAPI, Swagger or AsyncAPI spec, or of a Protobuf or GraphQL file
apigenie evolve	plans safe API changes: splits a breaking OpenAPI change into an expand wave and a contract wave (experimental)
apigenie format	formats OpenAPI, Swagger, AsyncAPI, Protobuf and GraphQL files
apigenie i18n	extracts texts for translation from OpenAPI, Swagger and AsyncAPI specs and Protobuf and GraphQL files, and applies translations to all of them
apigenie license	show licenses for API Genie and 3rd party dependencies
apigenie lint	lints OpenAPI, Swagger, AsyncAPI and Protobuf files
apigenie overlay	applies OpenAPI Overlays to an OpenAPI spec
apigenie test	runs .http files (HTTP, gRPC, WebSocket, MQTT) and generated requests against a live API and validates them against its OpenAPI or AsyncAPI spec or .proto file

Code is generated with the separate apigenie-generator executable: see apigenie-generator. Mock servers are started with the separate apigenie-server executable: see mock server. The API catalog of a repository is listed and kept with the separate apigenie-catalog executable: see catalog.