Openapi

11 items tagged with "openapi"

Filter by type:

Standards2

OpenAPI Specification 3.1.0

Language-agnostic interface description for HTTP APIs. 3.1 aligns fully with JSON Schema 2020-12.

Language-agnostic interface description for HTTP APIs. 3.2 keeps the JSON Schema 2020-12 alignment introduced in 3.1 and adds first-class descriptions for streaming and sequential media types, the QUERY method, and hierarchical tags. It is backward compatible with 3.1.

Best Practices2

Best Practice

OpenAPI Specification Best Practices

Guidance for writing accurate, machine-readable OpenAPI documents that describe HTTP APIs and drive docs, client SDKs, mocks, and contract tests.

Best Practice

API-First Design

An approach that treats the API contract as a product designed before implementation, so teams agree on the interface, then build clients and servers in parallel.

Tutorials1

Tutorial

How to Document an API with OpenAPI

Write an OpenAPI specification, serve interactive docs, validate requests against the schema, and generate client code.

Migrations1

Migration

Flask to FastAPI Migration

Migrate Python APIs from Flask to FastAPI with async support and OpenAPI-first contracts

Products1

Product

FastAPI

Modern, fast web framework for Python APIs

Stacks1

Stack

FastAPI + React

A modern Python stack with a FastAPI backend and a React front end, joining high-performance async APIs to a rich interactive UI.

Comparisons1

Comparison

OpenAPI vs AsyncAPI

OpenAPI describes synchronous request/response HTTP APIs; AsyncAPI describes event-driven, message-based APIs over brokers and streams.

Generators1

Generator

API Specification Converter

Convert API specifications between formats (OpenAPI, GraphQL, gRPC)

Glossaries1

Glossary

OpenAPI

OpenAPI is a language-agnostic specification for describing HTTP APIs in a machine-readable document, enabling shared contracts, documentation, and code generation.