Download the PHP package sdekkers/compass without Composer

On this page you can find all versions of the php package sdekkers/compass. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of sdekkers/compass

Informations about the package compass

Compass 🧭

Latest Version on Packagist PHP Version

Zero-config OpenAPI documentation for Laravel. No annotations. No docblocks. Just reads your code.

Features

Requirements

Installation

Quick Start

Your openapi.yaml and openapi.json are now in storage/app/compass/. Visit /docs to see the Swagger UI.

Configuration

Publish the config file:

Key options in config/compass.php:

Option Description
title API documentation title
version API version string
servers Server URLs for the spec
routes.prefixes Route prefixes to include (default: ['api'])
routes.exclude_patterns Glob patterns to exclude
grouping.enabled Auto-group by module namespace
ui.enabled Enable/disable Swagger UI
ui.path URL path for Swagger UI (default: docs)

How It Works

Compass inspects your Laravel application and extracts:

Validation Rule Mapping

Laravel Rule OpenAPI
string {type: "string"}
integer {type: "integer"}
boolean {type: "boolean"}
email {type: "string", format: "email"}
uuid {type: "string", format: "uuid"}
date {type: "string", format: "date"}
max:255 {maxLength: 255}
min:1 {minimum: 1}
in:a,b,c {enum: ["a","b","c"]}
nullable {nullable: true}

Contributing

Please see CONTRIBUTING.md for details.

License

The MIT License (MIT). Please see LICENSE for more information.

All versions of compass with dependencies

PHP Build Version
Package Version
Requires php Version ^8.4
illuminate/support Version ^11.0|^12.0|^13.0
illuminate/routing Version ^11.0|^12.0|^13.0
symfony/yaml Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package sdekkers/compass contains the following files

Loading the files please wait ...