Skip to main content

Streamline Your Backend with JSON Schema on Codehooks.io

· 3 min read
Jones
Jones
Maker and Architect @ Codehooks

In modern app development, having a reliable backend is essential. Codehooks.io offers a powerful NoSQL datastore, JSON schema validation, and a secure REST API to keep your data consistent and your app scalable.

socialcard

Why Backend Structure Matters​

A well-structured backend is key to:

  1. Data Integrity: JSON Schema enforces data structure, preventing invalid data from entering your system.
  2. Security: Strong authentication mechanisms protect your data.
  3. Scalability: Ready to handle growing data loads as your app expands.
  4. Flexibility: Seamless REST API integration connects easily with various clients.

Getting Started with Codehooks.io​

  1. Setup: Start by creating an account on Codehooks.io, installing the CLI, and initializing your project.
npm install -g codehooks
codehooks login
mkdir myproject && cd myproject
codehooks init

Get your project's endpoint URLs:

codehooks info
  1. Define JSON Schema: Maintain data consistency by defining a JSON Schema.

Example personSchema.json:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "Person",
    "type": "object",
    "properties": {
        "firstName": { "type": "string" },
        "lastName": { "type": "string" },
        "age": { "type": "integer", "minimum": 0 },
        "email": { "type": "string", "format": "email" }
    },
    "required": ["firstName", "lastName", "email"]
}

Apply the schema to your collection:

codehooks add-schema --collection 'person' --schema './personSchema.json'
  1. Import Data: Easily import data in JSON, CSV, or Excel format.
codehooks import --filepath './persondata.json' --collection 'person'
  1. Use the REST API: Interact with your data via the REST API.

Example for creating a record:

const newRecord = {
    lastName: "Doe",
    email: "[email protected]",
    age: 30
};

fetch('https://your-project-url/person', {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer YOUR_JWT_TOKEN'
    },
    body: JSON.stringify(newRecord)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

JSON Schema validation ensures only data that fits your schema gets through, returning a 400 error if it doesn't.

For example, if a required field is missing, the validator will return a 400 error like this:

{
    "schemaError": [
        {
            "instancePath": "",
            "schemaPath": "#/required",
            "keyword": "required",
            "params": {
                "missingProperty": "firstName"
            },
            "message": "must have required property 'firstName'"
        }
    ]
}

Codehooks.io Studio​

Prefer using a UI? Codehooks Studio offers a clean interface for managing your datastore, importing data, and setting up schemas—all without needing to write any code.

codehoooks studio json-schema

Wrapping Up​

Using JSON Schema on Codehooks.io ensures your backend is solid, with enforced data validation, ready-made APIs, and the scalability to grow with your app. Let Codehooks.io manage the backend so you can focus on building your application.

Further Reading and Learning​