Apiman Installation Guide
Branch: master
Clone or download
Pull request Compare This branch is 7 commits behind apiman:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
installation-guide
styles
.gitignore
GLOSSARY.adoc
LANGS.adoc
README.adoc
SUMMARY.adoc
book.json

README.adoc

Apiman Installation Guide

This guide provides detailed information about how to install and configure apiman.

Switching formats

{{ start }} {% method %}

On some pages different configuration instructions and examples are available for each platform. You can switch between the platforms by clicking the tabs at the top right of the page.

For example, on this page you can select Vert.x or Servlet, and will see different text in the example block.

{% sample lang="Vert.x" %} Your configuration file for Vert.x is conf.json!

{% sample lang="Servlet" %} Your configuration file for Servlet is apiman.properties!

{% endmethod %} {{ end }}

Understanding syntax

In many places in the documentation you will see format agnostic syntax which can be translated trivially into your chosen format.

For example:

Name Type Description

project.name

String

The project name

project.type

Enum

Must be one of: JAVA, GO

project.tags

String[]

Array of tags describing project

project.version.major

Integer

Project major release version

project.version.minor

Integer

Project minor release version

project.version.micro

Integer

Project micro release version

project.favourite

Boolean

Favourite project?

As JSON

{
  "project": {
    "name": "apiman",
    "type": "JAVA",
    "tags": ["api-management", "excellent"],
    "version": {
        "major": 1,
        "minor": 3,
        "micro": 0
    },
    "favourite": true
  }
}

As Properties

project.name=apiman
project.type=JAVA
project.tags=api-management,excellent
project.version.major=1
project.version.minor=3
project.version.micro=0
project.favourite=true