https://github.com/jonthegeek/rapid

R 'API' documents
https://github.com/jonthegeek/rapid

Last synced: 24 days ago
JSON representation

R 'API' documents

• Host: GitHub
• URL: https://github.com/jonthegeek/rapid
• Owner: jonthegeek
• License: other
• Created: 2023-07-28T19:52:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-12-16T13:27:12.000Z (4 months ago)
• Last Synced: 2025-03-18T01:42:38.770Z (28 days ago)
• Language: R
• Homepage: https://rapid.api2r.org/
• Size: 5.98 MB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 37
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• jimsghstars - jonthegeek/rapid - R 'API' documents (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# rapid

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)

[![CRAN status](https://www.r-pkg.org/badges/version/rapid)](https://CRAN.R-project.org/package=rapid)

[![Codecov test coverage](https://codecov.io/gh/jonthegeek/rapid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jonthegeek/rapid?branch=main)

[![R-CMD-check](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml)

Convert an API description (APID), such as one that follows the [OpenAPI Specification](https://spec.openapis.org/oas/v3.1.0), to an R API description object.

The R object belongs to a new [S7](https://rconsortium.github.io/S7) class, `rapid`, which enforces a strict, opinionated schema.

## Installation

::: {.pkgdown-release}

Install the released version of rapid from [CRAN](https://cran.r-project.org/):

``` r

install.packages("rapid")

```

:::

::: {.pkgdown-devel}

Install the development version of rapid from [GitHub](https://github.com/):

``` r

# install.packages("pak")

pak::pak("jonthegeek/rapid")

```

:::

## Usage

This package will be used by [{beekeeper}](https://beekeeper.api2r.org/) and [{mockplumber}](https://jonthegeek.github.io/mockplumber/).

## Code of Conduct

Please note that the rapid project is released with a [Contributor Code of Conduct](https://jonthegeek.github.io/rapid/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.