rapiclient-package: rapiclient: Open API (Swagger) Client

rapiclient-packageR Documentation

rapiclient: Open API (Swagger) Client

Description

Create R functions directly from OpenAPI (formerly Swagger) specification.

Creating a client

Use get_api to read the specification, get_operations to get client functions and get_schemas to create functions for additional schemas.

See usage example at https://github.com/bergant/rapiclient#rapiclient

Check out https://github.com/OAI/OpenAPI-Specification for additional information about Open API specification

Support

Please use https://github.com/bergant/rapiclient/issues for issues

Author(s)

Maintainer: Marcel Ramos marcel.ramos@sph.cuny.edu (ORCID) [contributor]

Authors:

Other contributors:

  • Alexandru Mahmoud [contributor]

  • Sean Davis [contributor]

  • Martin Morgan [contributor]

See Also

Useful links:

Examples

## Not run: 
# Read API description
api <- get_api(api_url)

# create operation and schema functions
operations <- get_operations(api)
schemas <- get_schemas(api)

# call service
operations$some_operation(x, y, schemas$some_structure(u, v, ...))

## End(Not run)


rapiclient documentation built on Oct. 1, 2024, 1:06 a.m.