Skip to content

APICHAP


With APICHAP you are able to construct your fully working API connected to your datasource with just a few steps.

Getting started

  1. Understand How It works
  2. Architecture Principles of the core Application
  3. Samples
  4. Launch with Docker
  5. Documentation
  6. Release Notes

Understand How It works

With APICHAP building your API application gets fairly easy. The basic idea is to use our AI assistant to generate the workflows, responses and logic for your API endpoints in our web portal in only a few moments. But instead of beeing a black-box our web application will provide you with configurations for each endpoint using the APICHAP configuration language. This enables you to download the configuration files and start the API using our APICHAP core container.

What is the best way to start?

The easiest way to start? Go to our web portal and start our setup wizard will guide you through creating your first API project.

What are the main parts of a APICHAP configuration?

  • Operations: A APICHAP project has one or more operation. Most of the time you will have one operation that is equal to your HTTP-endpoint. However it´s also possible to add other triggers to an operation such as timebased or reference execution. See the operations page for more details.
  • Fulfillments: Fulfillments are the hearts of our an APICHAP application. Each fulfillment has a specific purpose (type) and will retrieve, write and process data for you. One operation comes with a list of fulfillment. See fulfillments page for more details.
  • Datasources: Of course each API will need a place where to get data from. In our context that´s a datasource. Learn more about datasources & dataformats and it´s different on our detailed documentation page.

Architecture Principles of the core Application

APICHAP core is designed to run on your servers and is shipped as a docker image published on DockerHub.

The container will run with two files:

- Your openAPI Specification
- The Blueprint Configuration

On startup the container automatically generate your endpoints from the openAPI file and configure the workflows, datasource connections and data retrieval processes from the yaml configuration file.

APICHAP Architecture

Samples

Every start is easier with some samples. Find ours on GITHUB.

Quick reference

| File issues | Documentation | DockerHub | Samples |