Skip to content

A tool for rendering api blueprint and updating them to confluence

License

Notifications You must be signed in to change notification settings

nicolashohm/apib-confluencer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published