Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jsonapi.rest

Marketing site for the JSON:API suite, served via GitHub Pages at jsonapi.rest.

Static pages — no build step. Each page contains all its own markup, styles and scripts (code samples are hand-tokenised for syntax highlighting; no runtime highlighter):

  • index.html — the overview: the stack, one contract, and each layer.
  • examples.html — a hands-on tour of the API (fetch one, fetch a collection, filter, mutate, atomic operations), each shown as raw HTTP and the typed TypeScript client in a tabbed panel. Linked from the hero.

The suite

Layer Package Repo Docs
Server core (PHP) haddowg/json-api json-api docs
Symfony bundle haddowg/json-api-symfony json-api-symfony docs
TypeScript client @haddowg/json-api-client / -codegen / -query json-api-ts docs

Development

Open index.html in a browser, or:

python3 -m http.server 8000

Deployment

Pushes to main are served by GitHub Pages (branch: main, path: /). The CNAME file pins the custom domain.

About

Marketing site for the json-api suite — jsonapi.rest

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages