https://github.com/gregschmit/rest-scaffold
A JavaScript/jQuery library that builds scaffolds (tables+actions) for objects exposed by a REST API.
https://github.com/gregschmit/rest-scaffold
Last synced: 4 months ago
JSON representation
A JavaScript/jQuery library that builds scaffolds (tables+actions) for objects exposed by a REST API.
- Host: GitHub
- URL: https://github.com/gregschmit/rest-scaffold
- Owner: gregschmit
- License: mit
- Created: 2019-07-01T01:33:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T20:37:01.000Z (over 1 year ago)
- Last Synced: 2025-08-27T23:59:59.807Z (9 months ago)
- Language: JavaScript
- Size: 349 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# REST-Scaffold.js
`rest-scaffold.js` is a JavaScript library for building scaffolds (tables +
actions) that represent objects which are exposed by a RESTful API.
## How It Works
The basic idea is that you have some API at `https://example.com/api/thing` and
you provide a `div` with a `data-rest-scaffold` property which is a
configuration in the form of a JSON, like:
```json
{
"title": "Things",
"subtitle": "that go in the kitchen",
"recordTitle": "Thing",
"pkField": "id",
"url": "https://example.com/api/thing",
"csrfToken": "blahblah"
}
```
If you're using a tool like
[`django-rest-scaffolds`](https://github.com/gregschmit/django-rest-scaffold)
to generate all this, then the tool can escape the quotes in the JSON.
Otherwise, using single quotes for the property is helpful.
The `div` would look like this:
```html
```
The library will assume the following endpoints exist:
- `GET`->`thing` A listing of the objects
- `POST`->`thing` A creation of a single object
- `GET`->`thing/pk` A retrieval of a single object
- `PUT`->`thing/pk` A update of a single object
- `DELETE`->`thing/pk` A deletion of a single object
## CDN Links
https://cdn.jsdelivr.net/npm/rest-scaffold/dist/rest-scaffold.js
https://cdn.jsdelivr.net/npm/rest-scaffold/dist/rest-scaffold.css
## Configuration Options
### Common Options
`apiType` (string, default: `"plain"`) : This defines the structure of the API
that we are interacting with. `plain` indicates that a listing should return a
JSON list with no pagination. If you use Django with the Rest Framework
paginator, then you should put `django-paged`. This is a shortcut configuration
option and the individual attributes that this affects can all be edited
selectively.
`title` (string, default: `""`): The main bold text shown at the top of the
scaffold.
`subtitle` (string, default: `""`): Lighter text shown after the title at the
top of the scaffold.
`url` (string, default: `"/"`): The url that we should use to access the REST
API.
`csrfToken` (string, default: `""`): Cross-Site Request Forgery token to use
during `POST`/`PUT` requests.
`debug` (boolean, default: `true`): Whether debugging information (including
request payload) should be displayed in scaffold error messages.
`fields` (array, default: `[]`): The fields that we should expect. If this is
falsy, then the scaffold will try to infer them from a listing.
`pkField` (string, default: `"id"`): The field that we can use as a primary
key.
### Other Options
`actionsLabel` (string, default: `"."`): The label for the actions column in
the scaffold.
`csrfTokenHeader` (string, default: `"X-CSRFToken"`): The HTTP header for
passing the CSRF Token.
`isPaged` (boolean, default: `false`): Whether the API listing returns results
in a paged format.
`rawCreateForm` (string, default: `null`): The HTML create form.
`rawUpdateForm` (string, default: `null`): The HTML update form.
`recordTitle` (string, default: `"Record"`): The name for a single record.
## Development
To build:
$ npm run-script build
For watch/compile for any changes:
$ npm run-script watch