https://github.com/pke/xstate.io

xState REST API
https://github.com/pke/xstate.io

api api-service hypermedia-api koajs rest-api siren-json xstate

Last synced: 10 days ago
JSON representation

xState REST API

• Host: GitHub
• URL: https://github.com/pke/xstate.io
• Owner: pke
• Created: 2019-11-18T17:16:26.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-08T05:29:07.000Z (about 1 month ago)
• Last Synced: 2024-10-31T08:42:29.528Z (17 days ago)
• Topics: api, api-service, hypermedia-api, koajs, rest-api, siren-json, xstate
• Language: JavaScript
• Homepage: https://restlr.net/demo
• Size: 2.37 MB
• Stars: 9
• Watchers: 5
• Forks: 0
• Open Issues: 27
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# xState API Server

Exposes xState state charts as REST Hypermedia API using SIREN.

## `GET /`

Lists all known xState charts.

## Starting a state chart from a Gist

The gist must be public.

[xState Viz](https://xstate.js.org/viz/) saved state charts can be loaded for now.

### `GET /`

Fetches the given gist `machine.js` and generates a form to fill its context.

The forms action points to `POST /`

### `POST /?context`

Fetches the given gist `machine.js` file and builds it with the given `context`

variables.

### Example

Gist: `631ecba85437bb21a24ae86f67595623`

### Problems:

POST response "self" link points to POST original URL (incl. query). Shouldn't

it point to the resources URL instead?

## `POST /` - Create state chart service

You can create a new state chart service by calling

`POST /`

### Protect the service using Basic Authorization

Just send an `Authorization: Basic` HTTP header with your request.

When you want to interact with the service again, you have to send the same

Authorization header with every request.

**Note**: Protected services can not be made public at the moment. It's also not

possible at the moment to protect publicly created services.

A possible way to add such functionality via middleware would be to annotate the

possible actions for a resource. When its currently not protected the middleware

could inject an action to a `PUT /protect` endpoint and for protected services

a `DELETE /protect` to remove the protection or `PATCH /protect` to change the

credentials.

Future versions of the API could also support ACL scenarios for services.

So some users could then just read the service state and get updates but would

not be able to change it/delete it.

## `GET /bing/:daysBack?`

Gets the wallpaper of the day from Bing.

| param | description |

|-------|-------------|

| `daysBack` | can range from `0..7`. Defaults to `0`|

This can be used in CSS like:

```css

html {

  height: 100vh;

  width: 100vw;

}

body {

  height: 100%;

  width: 100%;

  background-size: cover;

  background-image: url(https://restlr.io/bing)

}

```