Open source components that make up ReadMe's API Explorer.
This repo consists of the following npm modules:
- @readme/api-explorer — the React components that make up the explorer
- @readme/http-status-codes — utility to lookup HTTP status codes
- @readme/markdown — the markdown parser
- @readme/markdown-magic — the legacy "magic block"-based markdown parser
- @readme/oas-extensions — an exported object of our OAS extensions
- @readme/oas-to-har — utility to transform an OAS operation into a HAR representation
- @readme/syntax-highlighter — the syntax highlighter in use on ReadMe
git clone git@github.com:readmeio/api-explorer.git
cd api-explorer
npm install
npx lerna bootstrapnpm testTo spin up an example server:
npm start# Fetch the latest
curl https://readme.readme.io/css/bundle-hub2.css -o example/bundle-hub2.css
# Remove relative paths for gh-pages
sed -i '' 's/\.\.\///g' example/bundle-hub2.css
ISC