Open sourceActive

OpenAPI Specification

OpenAPI Specification: Swagger Documentation Swagger Documentation OpenAPI Specification A standard format for defining APIs, ensuring structured and consistent endpoints, methods, parameters, and responses.

Open source page ↗

Field note

What it does

OpenAPI Specification v3.0.0 OpenAPI Specification v3.0.0 Version 3.0.0 26 July 2017 More details about this document This version: https://spec.openapis.org/oas/v3.0.0.html Latest published version: https://spec.openapis.org/oas/latest.html Latest editor's draft: https://github.com/OAI/OpenAPI-Specification/ Editors: Jeremy Whitlock Marsh Gardiner Ron Ratovsky Tony Tam Former editor: Jason Harmon Other versions: https://spec.openapis.org/oas/v3.2.0.html https://spec.openapis.org/oas/v3.1.2.html https://spec.openapis.org/oas/v3.1.1.html https://spec.openapis.org/oas/v3.1.0.html https://spec.openapis.org/oas/v3.0.4.html https://spec.openapis.org/oas/v3.0.3.html https://spec.openapis.org/oas/v3.0.2.html https://spec.openapis.org/oas/v3.0.1.html https://spec.openapis.org/oas/v2.0.html Participate GitHub OAI/OpenAPI-Specification File a bug Commit history Pull requests Copyright © 2017 the Linux Foundation What is the OpenAPI Specification? The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service. Status of This Document The source-of-truth for this specification is the HTML file referenced above as This version . Table of Contents 1. OpenAPI Specification 1.1 Version 3.0.0 2. Introduction 3.

Capabilities

Available capabilities

Tags

Tags

Ways to use it

Ways to use it

openapi

any / openapi-specification

openapi

any / openapi-specification

openapi

agnostic / openapi-specification

openapi

agnostic / OAS

openapi

any / OAS

openapi

Not filed / https://spec.openapis.org/oas/v3.2.0.html

openapi

any / openapi-specification

Product features

Product features

1.1 Version 3.0.0

1. OpenAPI Specification

2. Introduction

3.1 OpenAPI Document

3.2 Path Templating

3.3 Media Types

3.4 HTTP Status Codes

3. Definitions

OpenAPI Specification v3.0.0

Status of This Document

Version 3.0.0

What is the OpenAPI Specification?