@readme/api-explorer

UI components for the API explorer

13.4.18
latest
Source
npm

Version published: 3 years ago

Weekly downloads: 132; increased by1366.67%

Maintainers: 10

Weekly downloads

Created: 7 years ago

Source

@readme/api-explorer

UI components for the API explorer

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

FAQs

What is @readme/api-explorer?

Is @readme/api-explorer popular?

Is @readme/api-explorer well maintained?

Package last updated on 06 Jul 2021

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.

Install