All Projects → OAI → Openapi Specification

OAI / Openapi Specification

Licence: apache-2.0
The OpenAPI Specification Repository

Programming Languages

javascript
184084 projects - #8 most used programming language
shell
77523 projects
CSS
56736 projects
HTML
75241 projects

Projects that are alternatives of or similar to Openapi Specification

Swagger Ui
Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
Stars: ✭ 21,279 (-5.86%)
Mutual labels:  rest, openapi, openapi-specification, oas
Swagger Parser
Swagger Spec to Java POJOs
Stars: ✭ 468 (-97.93%)
Mutual labels:  rest, openapi, openapi-specification
Spectral
A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI v2 & v3.
Stars: ✭ 876 (-96.12%)
Mutual labels:  openapi, openapi-specification, oas
Drf Yasg
Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.
Stars: ✭ 2,523 (-88.84%)
Mutual labels:  rest, openapi, openapi-specification
Swagger Core
Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
Stars: ✭ 6,898 (-69.48%)
Mutual labels:  rest, openapi, openapi-specification
Generators
API Generator - instantly generate REST and GraphQL APIs (openapi (OAS) 3.0.0)
Stars: ✭ 213 (-99.06%)
Mutual labels:  rest, openapi, oas
Reservoir
A back end for your front end: a content repository. Powered by Drupal 8, JSON API and OAuth2.
Stars: ✭ 262 (-98.84%)
Mutual labels:  rest, openapi
Dapperdox
Beautiful, integrated, OpenAPI documentation.
Stars: ✭ 302 (-98.66%)
Mutual labels:  openapi, openapi-specification
Swagger Node
Swagger module for node.js
Stars: ✭ 3,917 (-82.67%)
Mutual labels:  rest, openapi-specification
Ring Swagger
Swagger Spec for Clojure Web Apps
Stars: ✭ 351 (-98.45%)
Mutual labels:  rest, openapi
openapi-schemas
JSON Schemas for every version of the OpenAPI Specification
Stars: ✭ 22 (-99.9%)
Mutual labels:  openapi, openapi-specification
Endpoints4s
Scala library to define HTTP-based communication protocols
Stars: ✭ 331 (-98.54%)
Mutual labels:  rest, openapi
Nswag
The Swagger/OpenAPI toolchain for .NET, ASP.NET Core and TypeScript.
Stars: ✭ 4,825 (-78.65%)
Mutual labels:  openapi, webapi
Openapi.tools
A collection of Editors, Linters, Parsers, Code Generators, Documentation, Testing
Stars: ✭ 257 (-98.86%)
Mutual labels:  openapi, openapi-specification
openapi3 parser
Open API 3 Parser/Validator for Ruby
Stars: ✭ 63 (-99.72%)
Mutual labels:  openapi, openapi-specification
Swagger Play
Stars: ✭ 320 (-98.58%)
Mutual labels:  rest, openapi-specification
go-openapi
OpenAPI Specification (OAS) 3.0 implementation for Go
Stars: ✭ 38 (-99.83%)
Mutual labels:  openapi, openapi-specification
Pode
Pode is a Cross-Platform PowerShell web framework for creating REST APIs, Web Sites, and TCP/SMTP servers
Stars: ✭ 329 (-98.54%)
Mutual labels:  rest, openapi
Swaggen
OpenAPI/Swagger 3.0 Parser and Swift code generator
Stars: ✭ 385 (-98.3%)
Mutual labels:  openapi, oas
Introspected Rest
An alternative to REST and GraphQL
Stars: ✭ 368 (-98.37%)
Mutual labels:  rest, apis

The OpenAPI Specification

Build Status Issue triagers

The OpenAPI Specification is a community-driven open specification within the OpenAPI Initiative, a Linux Foundation Collaborative Project.

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.

Use cases for machine-readable API definition documents include, but are not limited to: interactive documentation; code generation for documentation, clients, and servers; and automation of test cases. OpenAPI documents describe an APIs services and are represented in either YAML or JSON formats. These documents may either be produced and served statically or be generated dynamically from an application.

The OpenAPI Specification does not require rewriting existing APIs. It does not require binding any software to a service – the service being described may not even be owned by the creator of its description. It does, however, require the capabilities of the service be described in the structure of the OpenAPI Specification. Not all services can be described by OpenAPI – this specification is not intended to cover every possible style of HTTP APIs, but does include support for REST APIs. The OpenAPI Specification does not mandate a specific development process such as design-first or code-first. It does facilitate either technique by establishing clear interactions with a HTTP API.

This GitHub project is the starting point for OpenAPI. Here you will find the information you need about the OpenAPI Specification, simple examples of what it looks like, and some general information regarding the project.

Current Version - 3.1.0

The current version of the OpenAPI specification is OpenAPI Specification 3.1.0.

Previous Versions

This repository also contains all previous versions.

Each folder in this repository, such as examples and schemas, should contain folders pertaining to the current and previous versions of the specification.

See It in Action

If you just want to see it work, check out the list of current examples.

Tools and Libraries

Looking to see how you can create your own OpenAPI definition, present it, or otherwise use it? Check out the growing list of implementations.

Participation

The current process for development of the OpenAPI Specification is described in Development Guidelines. Development of the next version of the OpenAPI Specification is guided by the Technical Steering Committee (TSC). This group of committers bring their API expertise, incorporate feedback from the community, and expand the group of committers as appropriate. All development activity on the future specification will be performed as features and merged into this branch. Upon release of the future specification, this branch will be merged to main.

The TSC holds weekly web conferences to review open pull requests and discuss open issues related to the evolving OpenAPI Specification. Participation in weekly calls and scheduled working sessions is open to the community. You can view the TSC calendar online. Look for the "Subscribe to Calendar" button for instructions on subscribing.

The OpenAPI Initiative encourages participation from individuals and companies alike. If you want to participate in the evolution of the OpenAPI Specification, consider taking the following actions:

  • Review the current specification. The human-readable markdown file is the source of truth for the specification.
  • Review the development process so you understand how the spec is evolving.
  • Check the issues and pull requests to see if someone has already documented your idea or feedback on the specification. You can follow an existing conversation by subscribing to the existing issue or PR.
  • Subscribe to an open issue a day (or a week) in your inbox via CodeTriage.com.
  • Create an issue to describe a new concern. If possible, propose a solution.

Not all feedback can be accommodated and there may be solid arguments for or against a change being appropriate for the specification.

Licensing

See: License (Apache-2.0)

Analytics

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].