FakerAPI · JSON Structure

Fakerapi Envelope Structure

Shared response envelope returned by every FakerAPI endpoint.

Type: object Properties: 6 Required: 5
Test DataFake DataMockingDeveloper ToolsOpen SourcePublic APIs

ResponseEnvelope is a JSON Structure definition published by FakerAPI, describing 6 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

status code locale seed total data

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://fakerapi.it/structures/envelope.json",
  "name": "ResponseEnvelope",
  "description": "Shared response envelope returned by every FakerAPI endpoint.",
  "type": "object",
  "properties": {
    "status": { "type": "string", "description": "Always 'OK' on success." },
    "code": { "type": "int32", "description": "HTTP-style status code." },
    "locale": { "type": "string", "description": "Locale used to generate the payload." },
    "seed": { "type": "string", "description": "Seed echoed from the request, or null." },
    "total": { "type": "int32", "description": "Number of records returned in data." },
    "data": { "type": "array", "description": "Generated resource collection." }
  },
  "required": ["status", "code", "locale", "total", "data"]
}