https://github.com/amotivv/krates-backend
https://github.com/amotivv/krates-backend
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/amotivv/krates-backend
- Owner: amotivv
- License: mit
- Created: 2023-11-29T21:33:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-01T01:10:51.000Z (over 1 year ago)
- Last Synced: 2025-03-16T23:48:18.174Z (3 months ago)
- Language: TypeScript
- Size: 255 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/development.md
- License: LICENSE
Awesome Lists containing this project
README
Krates-Backend (based on Krates)
Krates-Backend is a free HTTP based JSON storage service. It is meant to be easy to use and easy to self-host. It lets you store, read & modify JSON data over HTTP APIs.
## 🔥Features
:white_circle: **Simple :** Zero configuration required and super easy to use.
:rainbow: **Backend Agnostic :** Use krates with a backend server or directly from the browser.
:closed_lock_with_key: **Protected Krates :** Protect your krates from unauthorized access.
:rocket: **Lightning Fast :** Saving your data is just a HTTP request away.
## Documentation
**API SPEC**
**General Information:**
- All API Endpoints are protected with a rate limiter.
- Status code 429 indicates rate limit exceeded.
**Endpoints:**
1. **Get Record Data**
- Path: `/krate/:krateId/record/:recordId/`
- Method: `GET`
- Params: `krateId` should be alphanumeric and 20 characters long, `recordId` should be alphanumeric and 24 characters long.
- Rate limit: Yes
- Response: JSON object with Record's data.
2. **Get all Data**
- Path: `/krate/:krateId/:collectionId?/`
- Method: `GET`
- Params: `krateId` should be alphanumeric and 20 characters long, `collectionId` optional and should be alphanumeric, min 1 character, max 16 characters.
- Rate limit: Yes
- Response: JSON object with all Data.
3. **Set Data**
- Path: `/krate/:krateId/:collectionId?/`
- Method: `POST`
- Params: `krateId` should be alphanumeric and 20 characters long, `collectionId` optional and should be alphanumeric, min 1 char, max 16 characters.
- Data: A payload of record data.
- Headers: `'x-api-key'` expected UUID format.
- Rate limit: Yes
- Authentication: Yes
- Response: JSON object containing the response to the request.
4. **Update Record Data**
- Path: `/krate/:krateId/:recordId/`
- Method: `PUT`
- Params: `krateId` should be alphanumeric and 20 characters long, `recordId` should be alphanumeric and 24 characters long.
- Data: Updated data.
- Headers: `'x-api-key'` expected UUID format.
- Rate limit: Yes
- Response: JSON Object with updated data.
5. **Delete All Data**
- Path: `/krate/:krateId/`
- Method: `DELETE`
- Params: `krateId` should be alphanumeric and 20 characters long.
- Headers: `'x-api-key'` expected UUID format.
- Rate limit: Yes
- Response: JSON object with success message on data deletion.
6. **Delete Record Data**
- Path: `/krate/:krateId/record/:recordId`
- Method: `DELETE`
- Params: `krateId` should be alphanumeric and 20 characters long, `recordId` should be alphanumeric and 24 characters long.
- Headers: `'x-api-key'` expected UUID format.
- Rate limit: Yes
- Response: JSON object with success message on record deletion.
7. **Get Meta Data**
- Path: `/meta/:krateId`
- Method: `GET`
- Params: `krateId` should be alphanumeric and 20 characters long.
- Response: JSON object with meta data for a krate.
Note: The mentioned `krateId`, `recordId`, `collectionId` & `'x-api-key'` are placeholders. Replace these with actual variables at the time of use. If authentication requirement is not mentioned, it is assumed to be not required.
## ✍️ Original Author of Krates
- [**Sumit Kolhe**](https://github.com/sumitkolhe) - _Author_
## 📜 License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE](LICENSE) file for details.