@publicodes/rest-api

@publicodes/api

This package allows you to create a REST API, which follows OpenAPI 3.0 specifications, from your Publicodes rules.

It consists of Koa middleware that adds routes to your router:

• POST /evaluate Evaluate one or more expressions with a given situation
• GET /rules Returns the list of all your rules
• GET /rules/{rule} Returns a specific rule

Installation

npm install @publicodes/api

Utilisation

import Router from '@koa/router'
import Koa from 'koa'
import Engine from 'publicodes'
import { koaMiddleware as publicodesAPI } from '@publicodes/api'

const app = new Koa()
const router = new Router()

// Create middleware with your Engine
const apiRoutes = publicodesAPI(new Engine('coucou: 0'))

// Basic routes usage (/evaluate, /rules, etc.)
router.use(apiRoutes)

// Or use with specific route prefix (/v1/evaluate, /v1/rules, etc.)
router.use('/v1', apiRoutes)

app.use(router.routes()).listen(3000)

// ...

A complete example file is in the sources if needed : example.ts.

Documentation

• Publicodes API
• Publicodes

Projets phares

• mycompanyinfrance API

Changelog

1.3.0

@publicodes/core

• Ajoute une méthode getSituation à l'Engine.

• Ajoute une option strict à l'engine qui permet de lever des erreurs au lieu de warning. Elle peut être finement configurée pour lever certaines erreurs et pas d'autres.

• Ajoute une option situation dans le mode strict. Si cette dernière est passée à false, alors les règles invalides de la situation seront filtrées sans lever d'erreurs. Une règle est invalide si :

  • La règle n'est pas présente dans la base de règle ou est privée
  • La réponse donnée via un mécanisme "une possibilité" n'est pas une option de réponse
  • La valeur donnée pour une règle n'est pas valide (syntaxe incorrecte, etc.)