Overview
API overview
What this API reference covers and how to try every request live.
This reference documents the Sample Posts API — a small, working API backed by the public JSONPlaceholder service. Every endpoint page has a Send button that runs the real request from your browser, so you can inspect live responses before writing a line of code.
Base URL
All requests use the same base URL:
https://jsonplaceholder.typicode.com
Try your first request
Open an endpoint
Pick Get a post from the Posts group in the sidebar.
Send it
Keep the default id of 1 and press Send. The response panel shows a
real 200 with the post body.
Change the input
Try an id above 100 to see the API's 404 behavior.
Writes are safe to experiment with: the demo server accepts POST requests
and echoes the created resource back with a generated id without storing it.
Make this reference yours
This sample exists so the reference has something real to show. To document
your own API, replace openapi.yaml at the repository root with your
specification — the endpoint pages, navigation, and playground regenerate from
it on the next publish.
Readers orient faster when a reference opens with what the API does, how to authenticate, and one runnable request. Rewrite this page and Authentication for your API instead of deleting them.
Was this page helpful?