Orders, a REST resource
List, create, read, patch and cancel, with paging, shared parameters and three reusable responses.
Pikkola Spec Lab, tool No. 64
Paste an OpenAPI 3.0 or 3.1 document as JSON or YAML. It is read, checked against the structure the specification requires, and turned into an endpoint explorer, three snippets and a converted copy. Nothing is sent anywhere, and no call is ever made.
The studio
Four tabs over one document. The report reads the structure, the explorer follows every path, the snippets write the call, and the converter moves the same file between JSON and YAML.
JSON or YAML is detected from the first character. The checker looks for the things that break a client: a missing response, a path parameter nobody declared, a reference that points at nothing.
ready
Grouped by their first tag, in the order the document declares. Open one to read its parameters, its request body and every response, with each reference resolved from this document.
0
Built from the selected operation: path parameters filled with the value the schema suggests, required headers in place, and a body shaped by the request schema. The URL is yours to change.
cURL
The same document in the other notation, written by this page rather than by a library: two space indents, block scalars for long text, and quotes only where a reader would otherwise guess wrong.
Presets
Each one is a whole spec, not a fragment: a REST resource, a token API and a webhook receiver. Load one into the studio, break something on purpose, and watch the report name it.
List, create, read, patch and cancel, with paging, shared parameters and three reusable responses.
Sign up, sign in, refresh and me, with bearer security and a 3.1 document that writes null as a type.
One signed inbound event, one envelope, and a data field that is one of two shapes.
How it reads
Nothing here calls the API. What it can do is compare the document with the rules the specification sets, and be honest about where that stops.
01
A brace in the path is a promise that a parameter with that name is declared and required. The checker reads both directions: a name in the path with no parameter is an error, and a path parameter the path does not contain is a warning, because the client cannot fill it.
02
OpenAPI 3 requires responses on every operation, and a client generator will refuse a document without them. The same goes for the status keys: 200, 2XX and default are read; sixty is not a status.
03
A local reference such as #/components/schemas/Order is resolved and shown where it is used, so a response tree reads as one piece. A reference to another file or another host is named in the report and left alone: this page makes no network request at all.
| Check | When it fails | Why it matters |
|---|---|---|
| responses on an operation | error | A client generator and a reviewer both stop here. |
| operationId repeated | error | Generated method names collide, and one of them wins silently. |
| path template and parameters | error | The caller has no way to fill the brace in the address. |
| a local reference | error | A shape that points at nothing breaks every reader, not just this one. |
| a response key | warning | A key that is not a status is skipped by every client. |
| a tag used and never declared | note | The grouping still works, but the documentation has no description for it. |
No. The content policy sets connect-src to none, so a request from this page cannot leave the tab. The checker reads the document you pasted and nothing else, which also means it cannot tell you that an endpoint is down or that a token is wrong.
OpenAPI 3.0.x and 3.1.x, in JSON or YAML. A Swagger 2.0 document is recognised and refused with a line saying so, because its shapes differ: definitions instead of components, basePath instead of servers.
It is the only name in the document that is meant to be unique and readable, and every generator uses it for a method name. When it is missing the snippet falls back to the method and the path; when it repeats, the report says which two operations share it.
No. A reference to another file or another host would mean a network request, and this page makes none. It is reported so you know the tree stops there. Local references are resolved all the way down, with a cycle guard so a schema that points at itself does not hang the page.
From the operation you selected: path parameters take the example or the first value the schema suggests, required and optional query parameters are filled with the same samples, headers are sent as declared, and the body is generated from the request schema with examples and defaults respected. The TypeScript tab writes interfaces for the schemas the request and response actually touch.
No. The document is parsed, checked and converted in this tab. It is kept in this browser's local storage so the page opens where you left it, and clearing site data for this domain removes it. Fonts come from this domain, and there is no third-party script, pixel or iframe.