readmeio / Api Explorer
Licence: mit
Open source components that make up ReadMe's API explorer
Stars: ✭ 73
Programming Languages
javascript
184084 projects - #8 most used programming language
api-explorer
Open source components that make up ReadMe's API Explorer.
This repo consists of the following npm modules:
- @readme/api-explorer — React components that make up the API Explorer
- @readme/api-logs — React components for ReadMe Metrics
- @readme/oas-extensions — An exported object of our OpenAPI extensions
- @readme/oas-to-har — Utility to transform an OpenAPI operation into a HAR representation
- @readme/oas-to-snippet — Utility to transform an OpenAPI operation into a code snippet
- @readme/variable — React components for ReadMe custom variables
Installation
git clone [email protected]:readmeio/api-explorer.git
cd api-explorer
npm ci
Running the tests
npm test
Usage
To spin up an example server:
npm start
Fetching the latest stylesheet from ReadMe (for the demo site)
# Fetch the latest
curl https://docs.readme.com/css/bundle-hub2.css -o example/bundle-hub2.css
# Remove relative paths for gh-pages
sed -i '' 's/\.\.\///g' example/bundle-hub2.css
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].