Skip to content

Quick Start

Quick reference

  • Samples!!
    GitHub offers some great samples helping you get started with APIchamp.

  • Where to file issues:
    GitHub

  • Get in contact:
    There are multiple ways to get in contact. Choose whatever suits you best.
    To get business related answers or request a demo, directly book a slot right here.
    Regarding technical questions, get in contact with our developers in our Public Discord Channel.
    Or simply hit us an e-mail for any topics: hello@apichamp.com.

  • Find the configuration and full documentation:
    Documentation

  • Docker Registry:
    DockerHub

  • Demo videos:
    Check our Youtube channel for some useful Getting Started Demo Videos: Video

  • Releases:
    Go to APICHAMP Release Page

Requirements

Concept

APIchamp Architecture

Docker Client

APIchamp is published on dockerhub and the docker image comes with everything you need to run. No other standalone installation necessary.

openAPI Specification

Every APIchamp instance is primarily based on an openAPI specification, which is used to document how your REST API should look like. If you are unaware on how the openAPI specification works get started here: openAPI.

As the openAPI Specification is the main source for the APIchamp it is mandatory to start APIchamp. If you don´t have a working openAPI Specification file on hands right now, don´t worry. Our sample repository also features some example files for you.

APIchamp Configuration (Blueprint)

As you have already learned each APIchamp is primaly based on a openAPI specification. The openAPI specification defines on How the REST-API will look like. You may already start the APIchamp instance only with the openAPI file. The requests are already working, but always delivering a HTTP-404 for default. The second part of the APIchamp concept is: "WHAT should happen when a request is called". This is defined in the APIchamp Blueprint file. Create your own configuration file here: Configuration

Launch your first APIchamp instance now

We propose to get started with one of our sample projects as all samples already provide you with the basic setup including a docker-compose, an openapi specification and a APIchamp configuration file.

If you already got you own openAPI specification file and an APIchamp blueprint file available you are able to go right ahead and start your APIchamp instance with the following docker run command: 

docker run -d -it
    -v "/specs/openapi.yaml:/app/openapi.yml"
    -v "/specs/config.yaml:/app/config.yml"
    -p 8080:8080
    apichamp/apichamp-core:latest

That´s it! You´re ready to call your endpoints now or if you run under debug mode see the documentation under http://localhost:8080/swagger-ui.html.