jonthegeek / rapid

R 'API' documents
https://rapid.api2r.org/
Other
6 stars 1 forks source link

definitions and abbreviations - consistency? #87

Open jimrothstein opened 5 months ago

jimrothstein commented 5 months ago

Not highest priority ... suggest more consistency in wording to ease a newcomer.

Examples seem to refer to same thing, albeit as concept or file or ... API,API description object, APID, OpenAPI spec, wrap APIs, 'OpenAPI' document, 'API'

Rapid: "Convert an API description (APID), such as one that follows the OpenAPI Specification, to an R API description object."

Beekeeper: "Use beekeeper to create and maintain R packages that wrap APIs" "given the URL of an OpenAPI spec in YAML format (or a rapid::class_rapid() object)"

apisguru "A client to interact with the APIs.guru API."

mockplumber 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’.