LIGHT

  • News
  • Docs
  • Community
  • Reddit
  • GitHub
Star

JSON RPC

You can use JSON to define the schema for each service and the server will use it to validate the request body.

There are two different part in the request body, meta data and data. The schema only applies to the data portion.

Here is an example of schema.

{
  "host": "lightapi.net",
  "service": "certification",
  "action": [
    {
      "name": "certifyEndpoint",
      "version": "0.1.0",
      "handler": "Endpoint",
      "scope" : "cert.endpoint.r",
      "schema": {
        "title": "Endpoint Certification",
        "type": "object",
        "properties": {
          "host": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "token": {
            "type": "string"
          },
          "environment": {
            "type": "string", 
            "enum": ["test", "prod"]
          }
        },
        "required": ["host", "path"]
      }
    },
    {
      "name": "certifyRegistry",
      "version": "0.1.0",
      "handler": "Registry",
      "scope" : "cert.registry.r",
      "schema": {
        "title": "Registry Certification",
        "type": "object",
        "properties": {
          "registryUrl": {
            "type": "string"
          },
          "environment": {
            "type": "string",
            "enum": ["test", "prod"]
          }
        },
        "required": ["registryUrl"]
      }
    }
  ]
}

How schema is loaded

Each service has a scheme file in the resources folder in the jar file. Multiple jar files can be put into a service folder that is part of the classpath of a hybrid server. When server is started, it will iterate all jar files in the classpath to load schema.json and mergge them together in memory.

Given the above loading logic, you cannot put the service jar file into a fat jar of the server as schema.json will be overwritten and only one is available at the end.

Json schema validation

Schema validation is done with json-schema-validator.

  • About Light Platform
    • Overview
    • Testimonials
    • What is Light
    • Features
    • Principles
    • Benefits
    • Roadmap
    • Community
    • Articles
    • Videos
    • License
  • Getting Started
    • Get Started Overview
    • Environment
    • Light Codegen Tool
    • Light Rest 4j
    • Light Tram 4j
    • Light Graphql 4j
    • Light Hybrid 4j
    • Light Eventuate 4j
    • Light Oauth2
    • Light Portal Service
    • Light Proxy Server
    • Light Router Server
    • Light Config Server
    • Light Saga 4j
    • Light Session 4j
    • Webserver
    • Websocket
    • Spring Boot Servlet
  • Architecture
    • Architecture Overview
    • API Category
    • API Gateway
    • Architecture Patterns
    • CQRS
    • Eco System
    • Event Sourcing
    • Fail Fast vs Fail Slow
    • Integration Patterns
    • JavaEE declining
    • Key Distribution
    • Microservices Architecture
    • Microservices Monitoring
    • Microservices Security
    • Microservices Traceability
    • Modular Monolith
    • Platform Ecosystem
    • Plugin Architecture
    • SOA
    • Scalability and Performance
    • Serverless
    • Service Collaboration
    • Service Mesh
    • Spring is bloated
    • Stages of API Adoption
    • Transaction Management
    • Microservices Cross-cutting Concerns Options
    • Service Mesh Plus
    • Service Discovery
  • Design
    • Design Overview
    • Design First vs Code First
    • Desgin Pattern
    • Service Evolution
    • Consumer Contract and Consumer Driven Contract
    • Handling Partial Failure
    • Idempotency
    • Environment Segregation
    • Multi-Tenancy
    • Why check token expiration
    • WebServices to Microservices
  • Cross-Cutting Concerns
    • Concerns Overview
  • API Styles
    • Light-4j for absolute performance
    • Style Overview
    • Distributed session on IMDG
    • Eventuate - Event Sourcing and CQRS
    • Hybrid - Modularized Monolithic
    • REST - Representational state transfer
    • Saga - Distributed Transactions
    • Tram - Transactional Messaging
    • Web Server with Light Platform
    • Websocket with light platform
    • Spring Boot Integration
    • Single Page Application
    • GraphQL - A query language for your API
  • Infrastructure Services
    • Service Overview
    • Light Proxy
    • Light Router
    • Introduction
    • Architecture
    • Light Portal
    • Messaging Infrastructure
    • Centralized Logging
    • Light OAuth2
    • Services
    • Metrics and Alerts
    • Reference
    • Config Server
    • Tokenization
  • Tool Chain
    • Tool Chain Overview
  • Utility Library
  • Service Consumer
    • Service Consumer
  • Development
    • Development Overview
    • Best Practices
    • Development Flow
    • Platform Developer
    • Develop Build
    • Application
    • Service Provider Developer
    • Service Consumer Developer
  • Deployment
    • Deployment Overview
    • Frontend Backend
    • Linux Service
    • Windows Service
    • Install Eventuate on Windows
    • Secure API
    • Client vs light-router
    • Memory Limit
    • Deploy to Kubernetes
  • Benchmark
    • Benchmark Overview
  • Tutorial
    • Tutorial Overview
  • Troubleshooting
    • Troubleshoot
  • FAQ
    • FAQ Overview
  • Milestones
  • Contribute
    • Contribute to Light
    • Development
    • Documentation
    • Example
    • Tutorial
“JSON RPC” was last updated: April 2, 2019: fixes #62 add Chinese language for the document site (5c820aa)
Improve this page
  • News
  • Docs
  • Community
  • Reddit
  • GitHub
  • About Light Platform
  • Getting Started
  • Architecture
  • Design
  • Cross-Cutting Concerns
  • API Styles
  • Infrastructure Services
  • Tool Chain
  • Utility Library
  • Service Consumer
  • Development
  • Deployment
  • Benchmark
  • Tutorial
  • Troubleshooting
  • FAQ
  • Milestones
  • Contribute