# davidhsianturi/laravel-compass

A REST client inside your Laravel app

Repository: https://github.com/davidhsianturi/laravel-compass
Canonical: https://ross.abutalabs.com/products/laravel-compass
Homepage: https://davidhsianturi.com/laravel-compass
Language: PHP
License: MIT
License Family: permissive
Topics: laravel, php, api, rest-client, api-documentation-tool, laravel-compass, laravel-framework, api-generator, rest-api, laravel-package, api-client, api-server
Last push: 2023-06-12T11:57:02+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 2588, "days_push": 1178, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1268, forks 108 (observed 2026-08-28T04:04:11.434091+00:00)

## What it is
Laravel Compass is a Laravel package that embeds a REST client UI inside your Laravel application. It auto-discovers your app's routes so you can test API calls (GET, POST, PUT/PATCH, DELETE, auth mechanisms) and generate API documentation from the browser.

## Use cases
- test my Laravel API endpoints without leaving the app
- generate API documentation from Laravel routes
- debug REST API requests with different auth mechanisms
- explore and call GET, POST, PUT, DELETE endpoints in a GUI
- replace Postman for testing my Laravel project's APIs

## When to choose
- you develop Laravel apps and want an in-app REST client
- you want API docs generated automatically from your Laravel routes
- you prefer a self-hosted, browser-based API testing tool tied to your codebase

## When to avoid
- your project is not built on Laravel
- you need a standalone API client independent of a specific framework
- you need actively maintained tooling - the last release was mid-2023

## Facets
- artifact type: plugin
- maturity: maintenance
- function: http-client, api-documentation, developer-tools
- domain: web-development, apis, developer-tools, documentation
- platform: php, self-hosted
- tags: laravel, rest-client, api-testing, api-docs, laravel-package, web-server

## Member repositories
- davidhsianturi/laravel-compass (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:04:11.434091+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T05:03:37.405183+00:00, confidence not recorded.
  - readme: https://github.com/davidhsianturi/laravel-compass (fetched 2026-08-28T04:04:11.434091+00:00, sha 1d31fb91a601)
  - homepage: https://davidhsianturi.com/laravel-compass (fetched 2026-08-29T12:15:16.729017+00:00, sha 0ee6662d27a8)
  - site_page: https://davidhsianturi.com/laravel-compass/installation (fetched 2026-08-29T12:15:16.731612+00:00, sha 6abea74ff921)
- Data as of 2026-08-30T08:39:29.467469+00:00.