openapi

(★ 275)

A set of packages and tools for working with OpenAPI, Swagger, Arazzo and Overlay Specification documents.

File Explorer

Download Latest Version (.zip)

- - speakeasy.png
- - format-coverage.sh
  - README.md
- - ci.yaml
  - commits.yml
  - coverage-comment.yaml
  - dependabot-tidy.yml
  - release.yaml
  - update-submodule-dependencies.yaml
- CODEOWNERS
- dependabot.yml
- build
- ci
- examples-check
- fmt
- fmt-check
- lint
- mod-check
- mod-tidy
- security
- setup-submodules
- test
- test-cli
- test-coverage
- update-examples
- update-lint-docs
- settings.example.json
- - arazzo.go
  - components.go
  - criterion.go
  - criterion_syncchanges_test.go
  - criterion_test.go
  - factory_registration.go
  - failureaction.go
  - info.go
  - outputs.go
  - parameter.go
  - payloadreplacement.go
  - requestbody.go
  - reusable.go
  - reusable_test.go
  - sourcedescription.go
  - step.go
  - successaction.go
  - workflow.go
- - condition.go
  - condition_test.go
  - criterion.go
  - criterion_test.go
  - criterion_validate_test.go
  - factory_registration.go
- - invalid.arazzo.yaml
  - simple.arazzo.yaml
  - speakeasybar.arazzo.yaml
  - test.arazzo.yaml
  - traintravelapi.arazzo.yaml
- arazzo.go
- arazzo_examples_test.go
- arazzo_order_test.go
- arazzo_test.go
- components.go
- factory_registration.go
- failureaction.go
- find_test.go
- info.go
- outputs.go
- parameter.go
- payloadreplacement.go
- README.md
- requestbody.go
- requestbody_test.go
- reusable.go
- reusable_test.go
- sourcedescription.go
- step.go
- successaction.go
- walk.go
- walk_test.go
- workflow.go
- example_test.go
- manager.go
- manager_test.go
- - go.mod
  - go.sum
  - main.go
- - main.go
- - main.go
- errors.go
- errors_test.go
- - value.go
- expression.go
- expression_test.go
- expressions.go
- expressions_test.go
- factory_registration.go
- string_test.go
- value.go
- value_test.go
- - extensions.go
  - extensions_test.go
- extensions.go
- extensions_isequal_test.go
- extensions_test.go
- factory_registration.go
- graph.go
- graph_test.go
- hashing.go
- hashing_test.go
- - interfaces.go
  - interfaces_test.go
- - sliceutil.go
  - sliceutil_test.go
- - utils.go
  - utils_test.go
- - references.go
  - references_path_test.go
  - references_test.go
  - references_windows_test.go
  - slices.go
  - slices_test.go
  - string_builder.go
  - string_builder_test.go
  - url_cache.go
  - url_cache_test.go
- - version.go
  - version_test.go
- json.go
- json_test.go
- embedded_map_test.go
- jsonpointer.go
- jsonpointer_test.go
- map_index_key_test.go
- models.go
- models_test.go
- models_yaml_fallback_test.go
- navigation.go
- yamlnode.go
- yamlnode_test.go
- - defs_test.go
  - discriminator.go
  - discriminator_32_test.go
  - discriminator_unmarshal_test.go
  - discriminator_validate_test.go
  - discriminator_version_test.go
  - externaldoc.go
  - externaldoc_unmarshal_test.go
  - externaldoc_validate_test.go
  - factory_registration.go
  - inline.go
  - inline_stress_test.go
  - inline_test.go
  - inline_timeout_test.go
  - jsonschema.go
  - jsonschema_nil_test.go
  - jsonschema_validate_test.go
  - registry.go
  - registry_test.go
  - resolution.go
  - resolution_chain.go
  - resolution_defs.go
  - resolution_defs_test.go
  - resolution_external.go
  - resolution_external_ref_test.go
  - resolution_external_test.go
  - resolution_registry.go
  - resolution_test.go
  - schema.go
  - schema30.dialect.json
  - schema31.dialect.json
  - schema31.meta.json
  - schema32.dialect.json
  - schema32.meta.json
  - schema_exclusive_validation_test.go
  - schema_getters_test.go
  - schema_isequal_test.go
  - schema_unmarshal_test.go
  - schema_validate_test.go
  - shallowcopy_test.go
  - types.go
  - validation.go
  - value.go
  - value_test.go
  - walk.go
  - walk_test.go
  - xml.go
  - xml_unmarshal_test.go
  - xml_validate_test.go
- - engine.go
  - engine_test.go
  - registry.go
  - registry_test.go
  - terminal_prompter.go
  - terminal_prompter_test.go
- - format_test.go
  - formatter.go
  - json.go
  - summary.go
  - text.go
- config.go
- config_loader.go
- config_test.go
- doc.go
- doc_test.go
- document.go
- document_test.go
- linter.go
- linter_test.go
- README.md
- registry.go
- registry_test.go
- rule.go
- - factory_integration_test.go
- - factory_registration.go
  - models.go
- coremodel.go
- coremodel_getters_test.go
- coremodel_jsonpath_test.go
- coremodel_jsonpointer_test.go
- duplicate_key_test.go
- empty_map_marshal_test.go
- extensions.go
- factory.go
- factory_test.go
- marshal.go
- marshalling_test.go
- model.go
- model_test.go
- node.go
- node_test.go
- nodecollector.go
- nodecollector_test.go
- populator.go
- populator_test.go
- populator_unmarshalextensionmodel_test.go
- sequencedmap.go
- sequencedmap_test.go
- syncer.go
- syncing_test.go
- unmarshaller.go
- unmarshalling_test.go
- - callbacks.go
  - callbacks_test.go
  - components.go
  - encoding.go
  - example.go
  - factory_registration.go
  - header.go
  - info.go
  - link.go
  - mediatype.go
  - openapi.go
  - operation.go
  - parameter.go
  - paths.go
  - paths_test.go
  - reference.go
  - reference_test.go
  - requests.go
  - responses.go
  - responses_test.go
  - security.go
  - security_test.go
  - server.go
  - tag.go
- - linter.go
  - linter_test.go
  - README.md
- - bootstrap_expected.yaml
  - invalid.openapi.yaml
  - petstore31.category.json
  - petstore31.openapi.json
  - petstore31.petdetails.json
  - petstore31.tag.json
  - simple.openapi.yaml
  - test.openapi.yaml
  - walk.additionaloperations.openapi.yaml
  - walk.openapi.yaml
- bootstrap.go
- bootstrap_test.go
- bundle.go
- bundle_test.go
- callbacks.go
- callbacks_unmarshal_test.go
- callbacks_validate_test.go
- circular_marshalling_test.go
- clean.go
- clean_paths_reachability_test.go
- clean_tags_test.go
- clean_test.go
- components.go
- components_unmarshal_test.go
- components_validate_test.go
- encoding.go
- encoding_unmarshal_test.go
- encoding_validate_test.go
- examples.go
- examples_test.go
- examples_unmarshal_test.go
- examples_validate_test.go
- factory_registration.go
- header.go
- header_unmarshal_test.go
- header_validate_test.go
- index.go
- index_external_test.go
- index_internal_test.go
- index_node_operation_test.go
- index_profile_test.go
- index_test.go
- info.go
- info_getters_test.go
- info_unmarshal_test.go
- info_validate_test.go
- inline.go
- inline_test.go
- join.go
- join_test.go
- links.go
- links_unmarshal_test.go
- links_validate_test.go
- localize.go
- localize_test.go
- marshalling.go
- mediatype.go
- mediatype_getters_test.go
- mediatype_multipart_validate_test.go
- mediatype_unmarshal_test.go
- mediatype_validate_test.go
- multifile_test.go
- nested_reference_tracking_test.go
- nil_getters_test.go
- openapi.go
- openapi_examples_test.go
- openapi_getters_test.go
- openapi_unmarshal_test.go
- openapi_validate_test.go
- operation.go
- operation_unmarshal_test.go
- operation_validate_test.go
- optimize.go
- optimize_test.go
- parameter.go
- parameter_unmarshal_test.go
- parameter_validate_test.go
- paths.go
- paths_getters_test.go
- paths_unmarshal_test.go
- paths_validate_test.go
- petstore31_id_test.go
- README.md
- reference.go
- reference_factory_test.go
- reference_getters_test.go
- reference_inline_test.go
- reference_mutex_test.go
- reference_resolve_test.go
- reference_unmarshal_test.go
- reference_validate_test.go
- requests.go
- requests_unmarshal_test.go
- requests_validate_test.go
- responses.go
- responses_unmarshal_test.go
- responses_validate_test.go
- sanitize.go
- sanitize_test.go
- security.go
- security_unmarshal_test.go
- security_validate_test.go
- serialization.go
- server.go
- server_test.go
- server_unmarshal_test.go
- server_validate_test.go
- snip.go
- snip_test.go
- tag.go
- tag_kind_registry.go
- tag_kind_registry_test.go
- tag_unmarshal_test.go
- tag_validate_test.go
- upgrade.go
- upgrade_test.go
- utils.go
- utils_test.go
- walk.go
- walk_components.go
- walk_matching.go
- walk_operations_test.go
- walk_schema.go
- walk_security.go
- walk_tags_servers.go
- walk_test.go
- walk_webhooks_callbacks.go
- - expr.go
  - expr_test.go
- - cyclic.yaml
  - petstore.yaml
- exec.go
- field.go
- format.go
- format_test.go
- module.go
- oq.go
- oq_test.go
- parse.go
- README.md
- - overlay.go
  - overlay_test.go
  - spec.go
  - spec_test.go
- - openapi-copy-expected.yaml
  - openapi-copy-move-expected.yaml
  - openapi-copy.yaml
  - openapi-overlayed.yaml
  - openapi-strict-onechange.yaml
  - openapi-version-header-expected.yaml
  - openapi-version-header.yaml
  - openapi.yaml
  - overlay-1.0.0-with-rfc9535.yaml
  - overlay-1.0.0.yaml
  - overlay-1.1.0-with-description.yaml
  - overlay-1.1.0-with-legacy.yaml
  - overlay-copy-errors.yaml
  - overlay-copy-move.yaml
  - overlay-copy-mutual-exclusive.yaml
  - overlay-copy.yaml
  - overlay-generated.yaml
  - overlay-mismatched.yaml
  - overlay-old.yaml
  - overlay-version-header.yaml
  - overlay-zero-change.yaml
  - overlay.yaml
  - removeNote.yaml
- apply.go
- apply_test.go
- compare.go
- compare_test.go
- copy_test.go
- format_test.go
- jsonpath.go
- jsonpath_test.go
- overlay_examples_test.go
- parents.go
- parse.go
- parse_test.go
- README.md
- schema.go
- upgrade.go
- upgrade_test.go
- utils.go
- utils_test.go
- validate.go
- validate_test.go
- pointer.go
- pointer_test.go
- factory_registration.go
- reference.go
- reference_test.go
- resolution.go
- resolution_cache.go
- resolution_cache_test.go
- resolution_test.go
- install.ps1
- install.sh
- map.go
- map_advanced_test.go
- map_getters_test.go
- map_isequal_test.go
- map_key_conversion_test.go
- map_mutation_test.go
- ordered_test.go
- utils.go
- utils_test.go
- yaml_unmarshal_test.go
- - edge_cases.expected.json
  - edge_cases.json
- edge_cases_test.go
- format.go
- format_test.go
- writer.go
- - externaldocs.go
  - factory_registration.go
  - info.go
  - operation.go
  - parameter.go
  - paths.go
  - paths_test.go
  - reference.go
  - reference_test.go
  - response.go
  - response_test.go
  - security.go
  - security_test.go
  - swagger.go
  - tag.go
- - petstore.expected.openapi.yaml
  - petstore.swagger.yaml
  - test.swagger.json
  - walk.swagger.json
- externaldocs.go
- externaldocs_nil_test.go
- factory_registration.go
- info.go
- info_getters_test.go
- info_validate_test.go
- marshalling.go
- operation.go
- operation_getters_test.go
- operation_validate_test.go
- parameter.go
- parameter_test.go
- paths.go
- paths_test.go
- README.md
- reference.go
- reference_factory_test.go
- response.go
- response_validate_test.go
- roundtrip_test.go
- security.go
- security_validate_test.go
- swagger.go
- swagger_test.go
- swagger_validate_test.go
- tag.go
- tag_validate_test.go
- upgrade.go
- upgrade_test.go
- walk.go
- walk_matching.go
- walk_test.go
- client.go
- filesystem.go
- filesystem_test.go
- errors.go
- fix.go
- options.go
- options_test.go
- prompter.go
- rules.go
- rules_test.go
- utils.go
- utils_test.go
- validation_test.go
- - eithervalue.go
  - eithervalue_test.go
  - value.go
- eithervalue.go
- eithervalue_integration_test.go
- eithervalue_jsonpointer_test.go
- eithervalue_populate_test.go
- eithervalue_sync_test.go
- eithervalue_test.go
- value.go
- locations.go
- locations_test.go
- set.go
- set_test.go
- config.go
- config_test.go
- nodekind.go
- nodekind_test.go
- walk.go
- walk_test.go
- yml.go
- yml_test.go
.gitattributes
.gitignore
.gitmodules
.golangci.yaml
.goreleaser.yaml
.mise.toml
AGENTS.md
CODEOWNERS
go.mod
go.sum
go.work
INSTALL.md
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/speakeasy-api/openapi

Downloads the entire project code from GitHub to your computer.

cd openapi

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Homebrew A package manager for macOS/Linux.
Go Go is required to use go install.

brew install openapi

Installs the pre-built package via Homebrew — no source build required.

go install github.com/speakeasy-api/openapi/cmd/openapi@latest

Downloads and installs the specified version directly — no need to clone the repo yourself.

curl -fsSL https://go.speakeasy.com/openapi.sh | bash

Downloads and runs the official install script in one line — this handles the full setup automatically.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

cd openapi/linter/customrules/testdata

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go install github.com/speakeasy-api/openapi/cmd/openapi@latest

Downloads and installs the specified version directly — no need to clone the repo yourself.

Type this command into your terminal and run it.

<a href="#installation"><img alt="Go Install" src="https://img.shields.io/badge/go%20install-ready-00ADD8.svg?style=for-the-badge&logo=go"></a>

Type this command into your terminal and run it.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

openapi

File Explorer

# Installation Guide

2. Official Install Script

3. Node.js

4. Go

Today's picks

Was this content helpful?

Recent Feedback

openapi

File Explorer

# Installation Guide

2. Official Install Script

3. Node.js

4. Go

Today's picks

Was this content helpful?

Recent Feedback

Download README