Giter VIP home page Giter VIP logo

jcaw's Introduction

The Problem

Interacting with Confluence's JSON-RPC API can be a hassle.

The Solution

jCAW, JSON-Confluence API Wrapper, makes working with Confluence's JSON API straight forward and easy to implement.

Install

    go to the dist folder and download the jCAW1.4.jar. Use it as a library in your project.

Example Code / Hello World

        // Creation & Connection Of A Service Object
        ConfluenceService myService = new ConfluenceService();
        myService.setBaseURL("https://confluenceServiceDomain.com");
        myService.setLoginToken("jprather", "qwerty");
        myService.setAPIVersion(1);    //myService.setAPIVersion(9) for jira
        myService.connect();
        
        // Building the parameters for the request
        List<Object> parameters = new LinkedList<Object>();
        parameters.add("xyz");
        
        // Perform the API call and store the JSONArray response
        JSONArray responseData;
        responseData = myService.requestJArray("methodName", parameters);

        // Another way to retrieve data - a List of HashMaps.
        //List<HashMap<String, String>> responseData;
        //responseData = myService.requestList("methodName", parameters);

        // Example / Print The Response
        if(responseData!=null){
             int z=0;
             for(z=0;z<responseData.size();++z) {
                System.out.println(responseData.get(z).toString());
             }
        }

Methods https://developer.atlassian.com/display/CONFDEV/Remote+Confluence+Methods

Dependencies

None! Just include the jar or source code in your project.

License

MIT: http://opensource.org/licenses/MIT

Other

Status:

  • Lib Complete.
  • Added experimental jira support

todo:

  • update authentication method (from os_username/os_password to basic auth)

jcaw's People

Contributors

jakehp avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

nhatchu

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.