https://github.com/jonthegeek/mockplumber

Mock servers from 'API' documentation
https://github.com/jonthegeek/mockplumber

Last synced: 10 days ago
JSON representation

Mock servers from 'API' documentation

• Host: GitHub
• URL: https://github.com/jonthegeek/mockplumber
• Owner: jonthegeek
• License: other
• Created: 2023-07-28T12:48:08.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-28T13:05:40.000Z (over 1 year ago)
• Last Synced: 2024-05-01T18:00:59.847Z (6 months ago)
• Language: R
• Homepage: https://jonthegeek.github.io/mockplumber/
• Size: 339 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• jimsghstars - jonthegeek/mockplumber - Mock servers from 'API' documentation (R)

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# mockplumber

[![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/mockplumber)](https://CRAN.R-project.org/package=mockplumber)

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

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

Create a 'plumber' file from an 'OpenAPI' document defining an 'API'. The 'plumber' file will have all the information to generate a mock server for that 'API'.

## Installation

You can install the development version of mockplumber from [GitHub](https://github.com/) with:

``` r

# install.packages("remotes")

remotes::install_github("jonthegeek/mockplumber")

```

## Usage

This is the beginning of an idea for a package.

You will use it with something like mockplumber::mock("https://api.apis.guru/v2/openapi.yaml").

## Code of Conduct

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