@readme/api-explorer

UI components for the API explorer

Usage no npm install needed!

<script type="module">
  import readmeApiExplorer from 'https://cdn.skypack.dev/@readme/api-explorer';
</script>

README

@readme/api-explorer

UI components for the API explorer

Build

Installation

npm install --save @readme/api-explorer

Usage

<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 pages
  • oasFiles - 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 not
  • suggestedEdits - whether suggested edits are enabled or not. This just toggles the button.
  • tryItMetrics - function to call when request is made
  • variables.user - user specific variables, setup via JWT login to ReadMe
  • variables.defaults - default project variables
  • glossaryTerms - glossary terms defined in the ReadMe project

Credits

Dom Harrington

Sanjeet Uppal

License

ISC