API Explorer

This repo consists of the following npm modules:

• @mia-platform/api-explorer: the React components that make up the explorer;
• @mia-platform/markdown: the markdown parser;
• @mia-platform/syntax-highlighter: the syntax highlighter in use on ReadMe;
• @mia-platform/oas-extensions: an exported object of Readme.io's OAS extensions;
• @mia-platform/variable.

Installation

git clone [email protected]:mia-platform/api-explorer.git
cd api-explorer
npm install
npm run boot # Installs all packages using lerna

Running the tests

npm test

Usage

To spin up an example server:

npm start

Tag a new version of the packages use:

npx lerna version

and select the desired version tag (major/minor/patch/etc...)

Build the packages for production:

npm run build

Deploy the latest example to gh-pages:

npm run deploy

Publish all modules to npm:

npx lerna publish

if publish fails with error Current HEAD is already released it's generally due to the fact that a version has already been tagged and there's no new change; in order to make sure it's published use

npx lerna publish from-git

so that lerna will not try to create a new version tag and publish the current version from the tag in the git repository.

License

MIT