R/rjsonapi-package.R

In sckott/rjsonapi: Consumer for APIs that Follow the JSON API Specification

#' @title rjsonapi
#' @description Consumer for APIs that follow the JSON API specification
#' @importFrom jsonlite fromJSON
#' @importFrom R6 R6Class
#' @importFrom plumber plumb
#' @importFrom crul HttpClient
#' @name rjsonapi-package
#' @aliases rjsonapi
#' @docType package
#' @author Scott Chamberlain
#' @keywords package
#'
#' @section JSON API:
#' JSON API is a specification for building APIs (Application Programming
#' Interfaces) in JSON (Javascript Object Notation).
#'
#' The JSON API website is at https://jsonapi.org/ . The specification
#' itself is at https://jsonapi.org/format/, with implementations at
#' https://jsonapi.org/implementations/
#'
#' @section Examples:
#' There are very few examples to see in the real world. One example
#' comes from CodeClimate. Their API docs are at
#' https://developer.codeclimate.com/#overview
NULL