apichap/apichap-core repository overview

⁠APICHAP

⁠Getting started

1. Architecture Principles⁠
2. Samples⁠
3. Launch with Docker⁠
4. Documentation⁠
5. Release Notes⁠

⁠Launch with Docker

Launch APICHAP on your environment by using the docker image from dockerhub⁠.

⁠Config files

! Precondition: APICHAP will only start if you provide valid configuration files.

• Your openAPI⁠ Specification
  
• The Blueprint Configuration⁠
  

Both files must be either copied or mounted into the /app folder of your apichap-core container.

⁠Launch with docker run

Start the APICHAP core image using docker run and mount the configuration files into the docker image /app folder.

docker run -it
  -v /opt/demo/specs/openapi.yaml:/app/openapi.yaml
  -v /opt/demo/specs/config.yaml:/app/config.yaml
  -p 8080:8080
  apichap/apichap-core:latest

⁠Launch with docker-compose

Start the APICHAP image by using docker-compose and mount the specs folder (having your configurations files) the docker image /app folder.

version: "3.9"
  services:
    apichap:
      image: apichap/apichap-core:latest
      ports:
        - "8080:8080"
      volumes:
        - ./specs:/app

⁠Samples

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

⁠Quick reference

| File issues⁠ | Documentation⁠ | DockerHub⁠ | Samples⁠ |

⁠License

View license information⁠ for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository's docker/ directory.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.