About this format
OpenAPI files strictly define the structure of REST APIs. JSON is one of the two standard formats for OpenAPI.
Example Data
{
"openapi": "3.0.0",
"info": {
"title": "Petstore API",
"version": "1.0"
},
"paths": {
"/pets": {
"get": {
"summary": "List all pets",
"responses": {
"200": {
"description": "A list of pets"
}
}
}
}
}
}When to use OpenAPI Petstore
- Documenting API endpoints
- Generating client SDKs
- Validating API requests