https://github.com/u12206050/directus-extension-api-viewer-module

A module for displaying your Directus api documentation directly within the App
https://github.com/u12206050/directus-extension-api-viewer-module

Last synced: about 2 months ago
JSON representation

A module for displaying your Directus api documentation directly within the App

• Host: GitHub
• URL: https://github.com/u12206050/directus-extension-api-viewer-module
• Owner: u12206050
• License: mit
• Created: 2022-04-23T05:41:13.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T10:51:05.000Z (about 1 year ago)
• Last Synced: 2024-04-13T14:49:30.268Z (9 months ago)
• Language: Vue
• Size: 7.07 MB
• Stars: 110
• Watchers: 1
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-directus - API Viewer - View and run API queries directly from a Module. (Extensions / Community)

README

        
# ARCHIVED

Recommend: [directus-extension-rapidocus](https://github.com/Belanchuk/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.

![ApiViewer](./screenshots/ApiViewer.gif "ApiViewer")

## Installation

### Via NPM

 - `npm install directus-extension-api-viewer`

### Manual

 - Download the latest [release](https://github.com/u12206050/directus-extension-api-viewer-module/releases/latest)

 - 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](https://github.com/mrin9/RapiDoc)

## 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