REST API Development

This page introduces you to using and developing REST APIs for Atlassian applications.

REST and Atlassian Plugins

Atlassian applications expose REST APIs that developers can use to access services of the Atlassian platform remotely. The REST APIs are presented by the platform components as well as any plugins that have implemented REST services

The REST APIs provide an alternative to the Java APIs used by in-process plugins. The REST APIs provide greater change-tolerance than in-process APIs. Before starting a plugin project, it's a good idea to start by looking at the REST APIs, even if you are developing a plugin intended to operate in-process with the host application. Of course, it's also the best option for developing remote applications that access Atlassian platform services. JIRA Studio is one example of such an application.

Getting Started

To develop your own clients that use the Atlassian REST APIS, see Getting Started with the REST APIs and the application-specific REST API documentation listed below. Also, the best place to get acquainted with the REST API available for use to a client application is by inspecting the target platform. Atlassian provides a tool for doing just that, the REST Application Browser (RAB). For information about the RAB, see Using the REST API Browser.

To create REST APIs in plugins you create for an Atlassian application, learn about the Atlassian REST plugin module and have a look at the tutorial, Developing a REST Service Plugin.

Application-Specific REST API Documentation

REST APIs
Confluence REST APIs
Crowd REST APIs
FishEye/Crucible REST APIs
JIRA REST APIs

API Development

Overview of REST implementation
Read an an overview of a REST implementation, using the Atlassian REST plugin module type.

REST plugin module type
Use the REST module type to create plugin points in Atlassian applications, by exposing services and data entities as REST APIs.

Principles behind the Atlassian REST API design
Understand the guidelines followed by the Atlassian developers who are designing REST APIs for Atlassian applications.

Powered by Confluence and Scroll Viewport