nicolashohm / apib-confluencer

A tool for rendering api blueprint and updating them to confluence

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Apib confluencer

A tool for rendering api blueprint files and updating them to confluence

Installation

Create a user specific config for storing the wiki credentials at ~/.apib_confluencer.json like:

{
    "confluence": {
        "username": "testuser",
        "password": "test-user-pw",
        "baseUrl":  "https://confluence-api-test.atlassian.net/wiki"
    }
}

Usage

Create a project config apib_confluencer.json in your project root like:

{
    "myapi.apib": {
        "pageId": 12345,
        "space": "ABC"
    }
}

To update the wiki page simply run

apib-confluencer

About

A tool for rendering api blueprint and updating them to confluence

License:MIT License


Languages

Language:JavaScript 100.0%