@mia-platform/api-explorer
UI components for the API explorer
Last updated 2 months ago by davidebianchi .
ISC · Repository · Original npm · Tarball · package.json
$ cnpm install @mia-platform/api-explorer 
SYNC missed versions from official npm registry.

@mia-platform/api-explorer

UI components for the API explorer

NPM version

Installation

npm install --save @mia-platform/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

License

ISC

Current Tags

  • 6.5.1                                ...           latest (2 months ago)

44 Versions

  • 6.5.1                                ...           2 months ago
  • 6.5.0                                ...           2 months ago
  • 6.4.1                                ...           3 months ago
  • 6.4.0                                ...           3 months ago
  • 6.3.6                                ...           3 months ago
  • 6.3.5                                ...           4 months ago
  • 6.3.4                                ...           4 months ago
  • 6.3.3                                ...           4 months ago
  • 6.3.2                                ...           4 months ago
  • 6.3.1                                ...           4 months ago
  • 6.3.0                                ...           4 months ago
  • 6.2.0                                ...           4 months ago
  • 6.1.1                                ...           6 months ago
  • 6.1.0                                ...           7 months ago
  • 6.0.2-alpha.3                                ...           8 months ago
  • 6.0.2-alpha.2                                ...           8 months ago
  • 6.0.2-alpha.1                                ...           8 months ago
  • 6.0.1                                ...           10 months ago
  • 6.0.0                                ...           a year ago
  • 6.0.0-rc.0                                ...           a year ago
  • 5.9.0                                ...           a year ago
  • 5.8.7                                ...           a year ago
  • 5.8.6                                ...           a year ago
  • 5.8.5                                ...           a year ago
  • 5.8.4                                ...           a year ago
  • 5.8.3                                ...           a year ago
  • 5.8.1                                ...           a year ago
  • 5.8.0                                ...           a year ago
  • 5.7.1                                ...           a year ago
  • 5.7.0                                ...           a year ago
  • 5.6.0                                ...           a year ago
  • 5.5.0                                ...           a year ago
  • 5.4.2                                ...           a year ago
  • 5.4.1                                ...           a year ago
  • 5.4.0                                ...           a year ago
  • 5.3.0                                ...           a year ago
  • 5.2.0                                ...           a year ago
  • 5.1.0                                ...           a year ago
  • 5.0.5                                ...           a year ago
  • 5.0.4                                ...           a year ago
  • 5.0.3                                ...           a year ago
  • 5.0.2                                ...           a year ago
  • 5.0.1                                ...           a year ago
  • 5.0.0                                ...           a year ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 37
Dev Dependencies (22)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |