A Directus module that displays API documentation within the Directus App, filtered by user permissions.
Directus Api Viewer Module is an extension for Directus that embeds API documentation directly within the Directus App interface. It displays API endpoints and specifications, dynamically filtered by the current user's permissions, allowing developers to reference documentation without switching contexts. It solves the problem of fragmented workflows by integrating docs into the admin environment.
Directus developers and administrators who need to reference API documentation while managing content or configuring the platform. It's particularly useful for teams building on Directus who require secure, role-based access to API specs.
Developers choose this module for its seamless integration with Directus, eliminating the need to use external tools or leave the app. Its unique permission-based filtering ensures documentation security, and the use of RapiDoc provides a modern, interactive documentation experience.
A module for displaying your Directus api documentation directly within the App
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Embeds API documentation directly into the Directus App interface, eliminating the need to switch to external tools and boosting developer productivity as highlighted in the README's philosophy.
Dynamically filters documentation based on the current user's permissions, ensuring secure, role-appropriate access without manual configuration, as described in the key features.
Utilizes RapiDoc for interactive and comprehensive API docs, providing a polished experience out-of-the-box, as noted in the shoutout section of the README.
Supports installation via NPM or manual file placement in the extensions directory, with clear steps outlined in the README for easy setup.
The project is marked as archived in the README, recommending an alternative, which means no future updates, bug fixes, or compatibility with newer Directus versions.
Relies solely on RapiDoc for rendering, with no flexibility to switch to other documentation tools like Swagger UI, limiting customization options.
Requires correct file placement in the extensions directory, which can be error-prone and lacks automated deployment options, as seen in the installation instructions.
The README lacks detailed usage examples, troubleshooting guides, or API customization instructions, making it harder for new users to adapt the module.