Implement REST API Infrastructure with Service Provider Pattern #185

bordoni · 2025-05-30T05:23:33Z

📋 Summary

This PR introduces a comprehensive REST API infrastructure for FakerPress, designed to replace the existing AJAX-based functionality with modern REST endpoints. The implementation follows FakerPress's established service provider pattern and WordPress coding standards.

🚀 What's New

Core Infrastructure

REST Controller Service Provider - Main controller extending Service_Provider pattern
Interface & Abstract Classes - Standardized contracts for all REST endpoints
OpenAPI 3.0 Documentation - Complete API documentation with schema generation
Documentation Endpoint - Self-documenting API accessible at /wp-json/fakerpress/v1/docs

API Namespace

All endpoints are available under: /wp-json/fakerpress/v1/

🛡️ Security Features

WordPress Authentication - Cookie and nonce-based auth
Capability Checking - Granular permission control per endpoint
Input Validation - Automatic parameter validation and sanitization
Error Handling - Standardized error responses

📖 Documentation

OpenAPI 3.0 Specification

Complete API documentation with schemas
Request/response examples
Security scheme definitions
Compatible with Swagger UI, Postman, etc.

Available Endpoints

GET /docs/openapi - Raw OpenAPI specification

🔄 Migration Path

This infrastructure prepares for migrating existing AJAX endpoints:

Current AJAX Actions (in Ajax.php):
- fakerpress.module_generate
- fakerpress.select2-WP_Query
- fakerpress.search_authors
- fakerpress.select2-search_terms
Future REST Endpoints:
- POST /posts/generate
- POST /users/generate
- POST /terms/generate
- POST /comments/generate
- POST /attachments/generate
- POST /meta/generate

🧪 Testing

The infrastructure includes:

Parameter validation and sanitization
Standardized response formats
OpenAPI schema validation
WordPress REST API compatibility

📋 Next Steps

Create individual endpoint classes for each module
Migrate AJAX functionality to REST endpoints
Update frontend to consume REST API
Maintain backward compatibility during transition

🔍 Code Quality

✅ WordPress Coding Standards compliance
✅ Proper docblock documentation
✅ Short array syntax for PHP
✅ Early return patterns for conditionals
✅ ES6 syntax ready for JavaScript integration

This PR establishes the foundation for FakerPress's REST API migration. The infrastructure is complete and ready for individual module endpoint implementation.

…mentation on how to integrate

- Refactor module.js to ES6 syntax with arrow functions, const/let, template literals - Replace WordPress AJAX with REST API endpoints for all module generation - Add comprehensive form data parsing for complex nested structures (fakerpress[taxonomy][0][qty][max]) - Implement smart numeric conversion (integers, floats, negatives) while preserving dates - Add proper internationalization support for both PHP and JavaScript - Fix REST API authentication with proper wp_rest nonce handling - Add data-endpoint attributes to all module forms (posts, users, terms, comments) - Enhance error handling with styled notices and detailed error messages - Restore links functionality to display generated item edit links - Filter empty form values to clean up API requests - Add wp-i18n dependency and script translations setup - Update Assets.php to localize REST API data for JavaScript Breaking changes: - Module generation now uses REST endpoints instead of admin-ajax.php - Form data structure optimized for REST API consumption - Requires wp-api-request and wp-i18n JavaScript dependencies Endpoints: - POST /wp-json/fakerpress/v1/posts/generate - POST /wp-json/fakerpress/v1/users/generate - POST /wp-json/fakerpress/v1/terms/generate - POST /wp-json/fakerpress/v1/comments/generate

…n, and OpenAPI schema generation - Add Handles_Batching trait for consistent batch processing across endpoints - Enhance Abstract_Endpoint with robust parameter validation and sanitization - Improve OpenAPI schema generation with proper endpoint args conversion - Refactor all endpoint classes (Posts, Comments, Terms, Users) to use batching trait - Add proper type hints and nullable permission handling - Fix Attachment module to include required WordPress admin functions for REST context - Streamline Documentation endpoint with cleaner OpenAPI spec delivery - Update Controller to use centralized OpenAPI base specification - Improve JavaScript module with enhanced error handling and ES6 patterns This commit significantly improves the REST API's reliability, consistency, and documentation while maintaining backward compatibility and following WordPress coding standards.

…r handling and type safety - Update all module classes (Comment, Post, Term, User) to use consistent parse_request signatures - Replace string error returns with WP_Error objects for better error handling - Add proper type hints (int $qty, array $request) to parse_request methods - Remove deprecated quantity calculation logic and legacy request handling - Improve docblock documentation with proper parameter descriptions - Update REST endpoints to handle WP_Error responses instead of string errors - Remove unnecessary imports and clean up namespace usage - Standardize error messages and codes across all modules This refactoring improves type safety, error handling consistency, and prepares the modules for better integration with the REST API architecture.

Copilot

Pull Request Overview

This PR establishes a REST API infrastructure for FakerPress using the service provider pattern, migrating AJAX actions to modern endpoints and adding OpenAPI support.

Introduce a central REST\Controller to register module endpoints under /wp-json/fakerpress/v1/
Implement individual endpoint classes (Posts, Users, Terms, Comments) with batching support and standardized request/response schemas
Add OpenAPI 3.0 documentation generation, update admin templates and assets to consume the new API

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/templates/pages/posts.php	Add `data-endpoint="posts"` attribute to the form
src/templates/pages/comments.php	Add `data-endpoint="comments"` attribute to the form
src/FakerPress/REST/Traits/Handles_Batching.php	New trait implementing batching logic for endpoints
src/FakerPress/REST/Controller.php	Service provider that loads and registers all endpoints
src/FakerPress/REST/OpenAPI.php	Utilities to build OpenAPI specification
src/FakerPress/REST/Endpoints/*	Individual endpoint classes for Posts, Users, Terms, Comments, Documentation
src/FakerPress/REST/README.md	Documentation for the REST API architecture and usage
src/FakerPress/Plugin.php	Bind and register the REST controller and endpoint implementations
src/FakerPress/Assets.php	Enqueue scripts with REST localization and i18n support

Comments suppressed due to low confidence (1)

src/FakerPress/REST/Traits/Handles_Batching.php:129

[nitpick] The batching success message uses cumulative item counts instead of batch number (e.g. 'Batch 20 of 100'). Consider renaming placeholders or computing the batch index to avoid misleading output.

__( '(Batch %d of %d total)', 'fakerpress' ),

src/FakerPress/REST/Endpoints/Users.php

src/FakerPress/REST/Endpoints/Comments.php

src/FakerPress/REST/Endpoints/Terms.php

src/FakerPress/Module/Attachment.php

src/FakerPress/REST/Endpoints/Posts.php

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

- Add Attachments REST endpoint with batching support - Create Attachment_View admin interface class - Implement complete attachment generation in parse_request - Add image providers (Placehold.co, Lorem Picsum) - Fix dropdown issues and JavaScript errors - Ensure PNG format for placehold.co to avoid SVG issues - Add size control via dimensions or aspect ratio - Support alt text, captions, and descriptions generation Resolves attachment generation returning 0 items and SVG format issues

… feature/rest-api

- Document version 0.9.0 with all REST API features - Add REST API section to feature descriptions - Include attachment generation documentation - Update stable tag to 0.9.0

- Remove module_generate method from Ajax class - Remove associated action hook - Clean up unused imports (Factory, View_Factory) - Module generation now handled exclusively through REST API

- Use specific Lorem Picsum image IDs instead of random parameter - Fetch image metadata from Lorem Picsum API to get author names - Include "Photo by [Author] on Unsplash" attribution in alt text - Update readme with new feature documentation This ensures proper attribution for photographers whose work is used

- Add placeholder() alias method to match expected Faker format - Fix WP_Attachment provider to use correct method names - Ensure both placeholder and lorempicsum providers work correctly Fixes "Unknown format 'placeholder'" exception

- Always add attribution for both Lorem Picsum and Placehold.co images - Remove conditional that prevented attribution when no caption was generated - Ensure every attachment has proper source attribution - Update documentation to reflect universal attribution All generated images now include attribution regardless of caption settings

- Removed redundant changelog line about attachment generation returning 0 items - Cleaned up changelog to maintain clarity and conciseness

- Add get_menu_icon_svg() method to Menu.php with FakerPress SVG icon - Use the actual fakerpress.svg from resources/img for consistency - Remove font icon CSS file and registration from Assets.php - Clear out font.pcss to remove custom font usage - Update changelog to document the change This modernizes the admin menu icon using native SVG support in WordPress

bordoni added 2 commits May 30, 2025 01:10

Include base layer for Rest API usage, OpenAPI documentation and docu…

d989957

…mentation on how to integrate

Improve loading of the REST API controller load

dfae9f2

bordoni self-assigned this May 30, 2025

bordoni added the type:feature label May 30, 2025

bordoni added 6 commits May 30, 2025 01:24

Incorrect owner

c0d47cd

Fix a couple of bad usages

453af69

Include all the Endpoint code

2e3257e

bordoni requested a review from Copilot June 9, 2025 18:53

Copilot AI reviewed Jun 9, 2025

View reviewed changes

bordoni and others added 12 commits June 9, 2025 16:08

Apply suggestions from code review

03ca431

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Apply suggestions from code review

0ecfdb6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'feature/rest-api' of github.com:bordoni/fakerpress into…

4f32f43

… feature/rest-api

docs: Add comprehensive changelog for REST API implementation

65a0e87

- Document version 0.9.0 with all REST API features - Add REST API section to feature descriptions - Include attachment generation documentation - Update stable tag to 0.9.0

refactor: Remove legacy AJAX module_generate implementation

9f0c938

- Remove module_generate method from Ajax class - Remove associated action hook - Clean up unused imports (Factory, View_Factory) - Module generation now handled exclusively through REST API

fix: Resolve Faker provider method name mismatch

e4b34f7

- Add placeholder() alias method to match expected Faker format - Fix WP_Attachment provider to use correct method names - Ensure both placeholder and lorempicsum providers work correctly Fixes "Unknown format 'placeholder'" exception

fix: Remove unnecessary changelog fix entry for attachment generation

9a4fb0f

- Removed redundant changelog line about attachment generation returning 0 items - Cleaned up changelog to maintain clarity and conciseness

chore: remove FakerPress custom font files and related font CSS

fd3fbbe

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Implement REST API Infrastructure with Service Provider Pattern #185

Implement REST API Infrastructure with Service Provider Pattern #185

Uh oh!

bordoni commented May 30, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Implement REST API Infrastructure with Service Provider Pattern #185

Are you sure you want to change the base?

Implement REST API Infrastructure with Service Provider Pattern #185

Uh oh!

Conversation

bordoni commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📋 Summary

🚀 What's New

Core Infrastructure

API Namespace

🛡️ Security Features

📖 Documentation

OpenAPI 3.0 Specification

Available Endpoints

🔄 Migration Path

🧪 Testing

📋 Next Steps

🔍 Code Quality

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bordoni commented May 30, 2025 •

edited

Loading