@readme/api-explorer
Advanced tools
UI components for the API explorer
npm install --save @readme/api-explorer
<ApiExplorer
docs={Array}
oasFiles={Object}
flags={Object}
appearance={{
referenceLayout: String,
}},
oauth={Boolean}
suggestedEdits={Boolean}
tryItMetrics={function}
variables={
user: {
keys: Array,
},
defaults: Array,
}
glossaryTerms={Array}
/>
docs - an array of objects from ReadMe containing all of your pagesoasFiles - an object of oas 3 files with the key being the _id of the apiSetting in readme e.g.{
'5a205ad8c2de471d1c80dd22': <OAS 3 file>
}
flags - an object of project flags from readme. Changing these will modify how the API Explorer works.appearance.referenceLayout - a string to determine the layout style, either row or column.oauth - whether this project uses oauth or notsuggestedEdits - whether suggested edits are enabled or not. This just toggles the button.tryItMetrics - function to call when request is madevariables.user - user specific variables, setup via JWT login to ReadMevariables.defaults - default project variablesglossaryTerms - glossary terms defined in the ReadMe projectISC
<small>13.4.18 (2021-07-06)</small>
FAQs
UI components for the API explorer
The npm package @readme/api-explorer receives a total of 317 weekly downloads. As such, @readme/api-explorer popularity was classified as not popular.
We found that @readme/api-explorer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 10 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.