@believablecreations/nestjs-joomla-web-api

A progressive Node.js framework for building efficient and scalable server-side applications.

Joomla API Integration for NestJS

Description

The Joomla API Integration for NestJS is a powerful and flexible NestJS plugin that enables seamless communication with Joomla's API. Designed for developers building applications that require data retrieval and management from Joomla-based websites, this plugin simplifies API interactions by providing an injectable service that handles authentication and request management.

Key Features

✅ Easy Setup – Quickly integrate Joomla's API with a simple module configuration using JoomlaModule.register().
✅ Dynamic Configuration – Supports environment variables (.env) for flexible API management across different environments.
✅ Dependency Injection – Provides a ready-to-use JoomlaService, making API calls effortless within NestJS applications.
✅ Secure API Access – Uses API keys to authenticate requests securely.
✅ Extendable & Scalable – Works with existing NestJS modules, allowing developers to build custom services using Joomla data.

How It Works

1. Install the package and register JoomlaModule in your AppModule.
2. Inject JoomlaService in controllers or services to fetch Joomla articles, categories, users, and more.
3. Enjoy seamless, scalable Joomla API interactions in your NestJS application.

This plugin is ideal for developers looking to integrate Joomla-based content and functionalities into NestJS applications while maintaining clean, modular, and maintainable code. 🚀

Installation

Install the package using npm or yarn:

npm install nestjs-joomla-api
# or
yarn add nestjs-joomla-api

Usage Import the Module Register the module in your AppModule:

import { Module } from '@nestjs/common';
import { JoomlaModule } from 'nestjs-joomla-api';

@Module({
  imports: [
    JoomlaModule.register({
      baseUrl: 'https://your-joomla-site.com/api',
      apiKey: 'YOUR_JOOMLA_API_KEY', // Or use environment variables
    }),
  ],
})
export class AppModule {}

License

Nest is MIT licensed.