API Documentation

Welcome to the Caesarjs.com API documentation. This section aims at setting out the API for the caesarjs secure microservice framework for node.js.

Key concepts:

Caesar.js is mainy based on the following concepts:

Pattern Matching Objects

Pattern matching objects instead of URLs. When defining a server-based service the API user provides an object pattern. While caesarjs server will create an internal url for the service, the client won’t need to know about it. The API user will have to provide the object pattern so the client can work out the actual URL for the required service. The pattern matching is based on the patrun module and defines 2 basic rules:

  1. More specific matches beat less specific matches. That is, more property values beat fewer.
  2. Property names are checked in alphabetical order.

Mutual Data Encryption

Data is encrypted when exchanged between server and client. This feature works out of the box.

Mutual Certificate Authentication

Caesarjs client & server can be easily configured to securely communicate via the SSL/HTTPS channel and perform mutual authentication.

Built on top of Express and Request

Caesarjs is built on top of the node.js’s community widely used Express server and Request client.

Dead easy API

Client & server feature a very comprehensive, easy to understand API.

Api documentation:

  • Server API documentation – This section gives an overall outline of the API for the server component for Caesar.js. With this API you can create server-side endpoints to be consumed by the client.
  • Server API documentation (Middleware) – This section also relates to the Server API component but is about the middleware section functionalities that are built in Caesar.js server.
  • Client API documentation – This page is about the client built-in API which is used to connect to a Caesar.js server and consume endpoints.
  • Plugin Builder API documentation – Finally, the plugin builder API section is about building new plugins to extend Caesar.js functionalities.