OpenAPI 3.1 Spec (YAML)
The same OpenAPI 3.1 description in YAML — the format most API definitions ship in. Paired with the JSON twin for testing YAML↔JSON conversion and spec parsers.
openapi: 3.1.0
info:
title: Novus Example API
version: 1.0.0
description: A tiny example API for testing OpenAPI tooling.
servers:
- url: https://api.example.com/v1
paths:
/users:
get:
summary: List users
operationId: listUsers
parameters:
- name: page
in: query
schema:
type: integer
default: 1
responses:
'200':
description: A page of users
content:
application/json:
schema:
$ref: '#/components/schemas/UserPage'
post:
summary: Create a user
operationId: createUser
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NewUser'
responses:
'201':
description: Created
'422':
description: Validation failed
/users/{id}:
get:
summary: Get a user
operationId: getUser
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:Specifications
- Format
- OpenAPI 3.1
- Paths
- 2
- Schemas
- 3
- Serialization
- YAML
What is a .yaml file?
YAML (YAML Ain't Markup Language) is a human-readable data-serialization format using indentation, key-value pairs, and lists, and is a superset of JSON. It supports comments, anchors, and multiple documents per file, favoring readability for configuration. Its indentation sensitivity makes it error-prone to hand-edit.
How to use this file
Use an example YAML file to test config parsers, indentation and anchor handling, multi-document streams, and safe-loading to avoid arbitrary object construction.
Related files
- jsonAPI Error — 404 (RFC 9457 problem+json)A 404 error body in RFC 9457 (problem+json) form, with type, title, status, detail, and instance — for testing structured error handling and problem-detail parsers.
- jsonAPI Error — 422 Validation (JSON)A 422 validation-error response with a machine-readable list of field errors — for testing form-validation surfacing and error mapping.
- jsonAPI Response — Users Page 1 (JSON)Page 1 of a paginated JSON API response (users), with page metadata and a `hasMore` flag. Paired with page 2 for testing pagination and infinite-scroll logic.
- jsonAPI Response — Users Page 2 (JSON)Page 2 (the final page) of a paginated JSON API response. Paired with page 1 for testing pagination, `hasMore` handling, and list merging.
- graphqlGraphQL Schema (SDL)A GraphQL Schema Definition Language (SDL) file with queries, a mutation, object/input types, and an enum — for testing GraphQL schema parsers, linters, and code generators.
- protoProtocol Buffers Schema (proto3)A proto3 Protocol Buffers schema with messages, an enum, and a repeated field — for testing protobuf compilers (protoc), codegen, and schema tooling.
Generated by generation/data_dev_fixtures.py. Free for any use, no attribution required — license.