ARCHIVED

Recommend: directus-extension-rapidocus

Directus Api Viewer Module

View your Directus Api documentation within the App.

Documentation is based on the permissions for the current user.

Installation

Via NPM

• npm install directus-extension-api-viewer

Manual

• Download the latest release
• Unzip and move index.js to [YOUR_PROJECT]/extensions/modules/api-viewer/index.js

Enable the module under Project Settings

Shoutout

Based on the awesome rapidoc component by @mrin9

Development

• Pull repo to [YOUR_PROJECT]/packages/modules/api-viewer
• Run npm install
• Run npm run dev
  • Watches and rebuilds on changes
  • Moves built index.js to [YOUR_PROJECT]/extensions/modules/api-viewer/index.js
• Run npm run build
  • Builds index.js to [YOUR_PROJECT]/extensions/modules/api-viewer/index.js

Contributing

• Fork this repo
• Create a new branch
  • feat/[YOUR_FEATURE]
  • fix/[YOUR_BUG | ISSUE]
• Make your changes
• Commit and push
• Create a pull request