Prerequisites | Declaring a simple endpoint | The basic syntax | Adding inputs | Binding state | Testing | An example
This package is hidden from search results because it is not hosted in the universe of the upstream owner
reside-ic. To fix this you can add URL: https://mrc-ide.r-universe.dev/porcelain to the package DESCRIPTION file. See also theR-universe documentation.Package: porcelain 0.1.16
Rich FitzJohn
porcelain: Turn a Package into an HTTP API
Wrapper around the plumber package to turn a package into an HTTP API. This adds some conventions that we find useful, such as some testing infrastructure and automatic validation of responses against a json schema.
Authors:
porcelain_0.1.16.tar.gz
porcelain_0.1.16.zip(r-4.7)porcelain_0.1.16.zip(r-4.6)porcelain_0.1.16.zip(r-4.5)
porcelain_0.1.16.tgz(r-4.6-any)porcelain_0.1.16.tgz(r-4.5-any)
porcelain_0.1.16.tar.gz(r-4.7-any)porcelain_0.1.16.tar.gz(r-4.6-any)
porcelain_0.1.16.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
porcelain/json (API)
| # Install 'porcelain' in R: |
| install.packages('porcelain', repos = c('https://mrc-ide.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/reside-ic/porcelain/issues
Last updated from:674b6c1721 (on master). Checks:7 ERROR, 2 OK. Indexed: no.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | ERROR | 151 | ||
| source / vignettes | OK | 224 | ||
| linux-release-x86_64 | ERROR | 141 | ||
| macos-release-arm64 | ERROR | 125 | ||
| macos-oldrel-arm64 | ERROR | 126 | ||
| windows-devel | ERROR | 110 | ||
| windows-release | ERROR | 103 | ||
| windows-oldrel | ERROR | 95 | ||
| wasm-release | OK | 123 |
Exports:porcelainporcelain_add_headersporcelain_backgroundporcelain_endpointporcelain_input_body_binaryporcelain_input_body_jsonporcelain_input_queryporcelain_loggerporcelain_package_endpointporcelain_returningporcelain_returning_binaryporcelain_returning_jsonporcelain_returning_textporcelain_rocletporcelain_stateporcelain_stop
Dependencies:askpassclicrayoncurlfastmaphttpuvidsjsonlitejsonvalidatelaterlgrlifecyclemagrittrmimeopensslotelplumberpromisesR6RcpprlangsodiumstringiswaggersysuuidV8webutils
roxygen
Last update: 2021-11-12
Started: 2021-11-12
cookbook
GET endpoint, inputs as query parameters, returning JSON | GET endpoint, inputs as path and query parameters, returning JSON | POST endpoint, inputs as JSON, returning JSON | POST endpoint, inputs as binary, returning binary
Last update: 2021-09-03
Started: 2021-09-03
porcelain
Motivation | Introduction - a porcelain approach to adding-as-a-service
Last update: 2021-09-03
Started: 2021-09-03
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| A 'porcelain' object | porcelain |
| Add headers to endpoint output data | porcelain_add_headers |
| While porcelain makes it easy to test endpoints individually, you may still want some integration or end-to-end tests where you bring the entire API up and interact with it from your tests. This class provides a helper for doing this in a way that is reasonably tidy. | porcelain_background |
| Basic endpoint object | porcelain_endpoint |
| Control for body parameters | porcelain_input_body_binary porcelain_input_body_json |
| Control for query parameters | porcelain_input_query |
| Create logger | porcelain_logger |
| Find roxygen-defined endpoint | porcelain_package_endpoint |
| Support for endpoint return types | porcelain_returning porcelain_returning_binary porcelain_returning_json porcelain_returning_text |
| Define API using roxygen tags | porcelain_roclet |
| Bind state into an endpoint | porcelain_state |
| Throw an error from an endpoint | porcelain_stop |
