Atlassian REST API Policy

Atlassian

API Lifecycle

Versioning

How to handle API versioning

Governance

How to ensure API governance (advertise, consistency, …)

Collection Resources

Pagination

How to retrieve a range of resources in a collection

HTTP Protocol

HTTP Headers

How to use standard or custom HTTP headers

Miscellaneous

Rate limiting

How to provide information about how many calls a consumer can do

Developer experience

How to take care of developer experience (DX)

Resources

URL format

How to design URLs