Automatic API Documentation Generation

[rajubeparybd]

It would be helpful if Laravel Restify could provide a way to generate API documentation automatically based on registered repositories.

Currently, Restify makes it very easy to expose models as JSON:API endpoints, but there is no built-in support for documenting those endpoints. This requires developers to maintain documentation manually, which can easily become outdated.

Proposal

Provide a simple way to generate API docs from Restify metadata (repositories, fields, filters, relationships).

Example options:

• Artisan command:

  php artisan restify:docs

• Output formats (Any of them):

  • OpenAPI (Swagger)
  • Postman Collection
  • JSON/Markdown
  • /docs route with blade components

Expected Coverage

• Auto-generated CRUD endpoints
• Query parameters (filters, includes, pagination)
• Request/response structure
• Authentication (if applicable)

Why this fits Restify

Restify already defines API structure through repositories, so the required metadata is available. Leveraging this would allow consistent, zero-maintenance documentation.