Najaah LMS - API Agent

Design and implement RESTful Laravel APIs for Najaah LMS with Scribe documentation.

Updated Dec 1, 2025
One-click install
npx skills add https://github.com/tarekBassiouny/najaah-backend --skill najaah-lms-api-agent
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Najaah LMS - API Agent
Source: https://github.com/tarekBassiouny/najaah-backend/tree/main/.claude/skills/najaah-api
Command: npx skills add https://github.com/tarekBassiouny/najaah-backend --skill najaah-lms-api-agent

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines the development of robust, well-documented, and maintainable APIs for the Najaah LMS platform, ensuring consistency and adherence to best practices.

Core Features & Use Cases

  • API Design & Implementation: Follows RESTful conventions for endpoint design, controller implementation, and validation.
  • Resource Formatting & Documentation: Utilizes API Resources for consistent response structures and Scribe for automatic documentation generation.
  • Error Handling & Versioning: Implements standardized error responses and a clear API versioning strategy.
  • Use Case: When developing a new feature for Najaah LMS that requires user data, use this Skill to design the API endpoints, implement the controllers, define validation rules, format the responses, and generate the necessary documentation.

Quick Start

Use the Najaah API Agent to design a new POST endpoint for creating courses under /api/v1/courses.

Frequently Asked Questions about Najaah LMS - API Agent

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I build a RESTful API endpoint in Laravel for an LMS platform?

To build a RESTful API endpoint in Laravel, you design routes under versioned prefixes like `/api/v1/`, implement controller patterns for logic, apply FormRequest validation, and use API Resources for consistent JSON response formatting.

What is the best way to generate API documentation for a Laravel RESTful API?

The best way to generate API documentation for a Laravel RESTful API is using Scribe, which automatically documents your endpoints, request validation rules, and API resource responses to ensure maintainable developer docs.

How does FormRequest validation handle API errors in Laravel controllers?

FormRequest validation handles API errors by automatically intercepting invalid requests and returning standardized error response structures, ensuring robust API error handling and data validation before hitting controller logic.

Can I organize Laravel API routes by feature and apply rate limiting to specific endpoints?

Yes, you can organize Laravel API routes by feature to maintain clean architecture and apply rate limiting via middleware to control traffic, alongside implementing API versioning strategies and standardized response pagination.

How do I format API responses and implement pagination for Laravel resource collections?

Format API responses by transforming models using API Resources, which standardize output structures, and implement pagination, filtering, and sorting directly within resource collections to manage large data sets efficiently.