Package: porcelain 0.1.15
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.15.tar.gz
porcelain_0.1.15.zip(r-4.5)porcelain_0.1.15.zip(r-4.4)porcelain_0.1.15.zip(r-4.3)
porcelain_0.1.15.tgz(r-4.4-any)porcelain_0.1.15.tgz(r-4.3-any)
porcelain_0.1.15.tar.gz(r-4.5-noble)porcelain_0.1.15.tar.gz(r-4.4-noble)
porcelain_0.1.15.tgz(r-4.4-emscripten)porcelain_0.1.15.tgz(r-4.3-emscripten)
porcelain.pdf |porcelain.html✨
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 9 months agofrom:655da3517c (on master). Checks:OK: 5 NOTE: 2. Indexed: no.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Oct 26 2024 |
| R-4.5-win | NOTE | Oct 26 2024 |
| R-4.5-linux | NOTE | Oct 26 2024 |
| R-4.4-win | OK | Oct 26 2024 |
| R-4.4-mac | OK | Oct 26 2024 |
| R-4.3-win | OK | Oct 26 2024 |
| R-4.3-mac | OK | Oct 26 2024 |
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:askpassclicrayoncurlellipsisfastmapgluehttpuvidsjsonlitejsonvalidatelaterlgrlifecyclemagrittrmimeopensslplumberpromisesR6RcpprlangsodiumstringiswaggersysuuidV8webutils
cookbook
Rendered fromcookbook.Rmdusingknitr::rmarkdownon Oct 26 2024.Last update: 2021-09-03
Started: 2021-09-03
porcelain
Rendered fromporcelain.Rmdusingknitr::rmarkdownon Oct 26 2024.Last update: 2021-09-03
Started: 2021-09-03
roxygen
Rendered fromroxygen.Rmdusingknitr::rmarkdownon Oct 26 2024.Last update: 2021-11-12
Started: 2021-11-12
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 |
