PHPackages                             rsthn/rose-api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. rsthn/rose-api

ActiveProject[API Development](/categories/api)

rsthn/rose-api
==============

Rose API Project Skeleton

v3.0.0(4mo ago)1115Apache-2.0Dockerfile

Since Feb 3Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/rsthn/rose-api)[ Packagist](https://packagist.org/packages/rsthn/rose-api)[ Docs](https://github.com/rsthn/rose-api)[ RSS](/packages/rsthn-rose-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (52)Used By (0)

Rose API Project Skeleton
=========================

[](#rose-api-project-skeleton)

This repository contains a sample project to use as skeleton to build APIs with Rose to be fully compliant with [Wind](https://github.com/rsthn/rose-core/blob/master/Wind.md). Install using composer:

```
composer create-project rsthn/rose-api
```

After installation edit your `composer.json` file to reflect your own project details.

Quick Test
----------

[](#quick-test)

Let's assume you installed the project in a folder named `test`, open your browser and navigate to `http://localhost/test/`, if everything is fine you should see the JSON result, as follows:

```
{
	"response": 200,
	"framework": "rsthn/rose-core",
    "version": "5.0.0"
}
```

There is also another API function named `now`, if you navigate to `http://localhost/test/?f=now` the result should be:

```
{
	"response": 200,
	"server_time": "2024-04-08 07:20:12",
    "database_time": "2024-04-08 07:20:12"
}
```

Now, for simplicity if you don't like to use the `f` parameter (*which is fine, by the way*) but rather a URL path (such as `http://localhost/test/now`), you can configure your web server to rewrite the URL. When using Apache-compatible use the following in your `.htaccess` file:

```
RewriteEngine On
RewriteBase /test/

RewriteCond %{SCRIPT_FILENAME} !-f
RewriteCond %{SCRIPT_FILENAME} !-d
RewriteRule ^(.*)$ index.php/$1 [L,QSA]

```

And with that, your pretty URLs will be supported.

Configuration
=============

[](#configuration)

Ensure you have a `rose-env` file on the root of this project with the name of the appropriate configuration environment to use (i.e. `dev`, `prod`, etc). Rose will load the `dev.conf`, `prod.conf` or whichever file you specify (along with `system.conf` by default) from the `conf` folder. Edit the conf files to reflect the configuration of your system.

*Note that the `rose-env` file should not be commited to ensure it is never overwritten in destination servers.*

API Interaction
===============

[](#api-interaction)

The service provided by this project is compliant with Wind, more information about it can be found in the [Wind](https://github.com/rsthn/rose-core/blob/master/Wind.md) API behavior documentation.

- The root folder for all API functions (`.fn` files) is `fn` because Wind is the Rose service that will take care of the API interaction.
- The `f` request parameter indicates the name of the function to execute, this parameter can have only the characters `[#A-Za-z0-9.,_-]`, any other character will be removed.
- The dot `.` character is used as path separator, therefore invoking `sys.users.add` will cause Wind to load the `fn/sys/users/add.fn` file.

Dependencies
============

[](#dependencies)

The following extensions are installed with this project:

- [rsthn/rose-ext-sentinel](https://github.com/rsthn/rose-ext-sentinel)
- [rsthn/rose-ext-shield](https://github.com/rsthn/rose-ext-shield/)

###  Health Score

44

—

FairBetter than 92% of packages

Maintenance78

Regular maintenance activity

Popularity11

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 96.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~36 days

Recently: every ~84 days

Total

51

Last Release

127d ago

Major Versions

v1.0.24 → v2.0.02024-04-08

v2.0.26 → v3.0.02026-01-10

### Community

Maintainers

![](https://www.gravatar.com/avatar/c882137e3e41afe0d0ef09b65e8c4dab3858accc70a2ca84181c9261a0447cdd?d=identicon)[rsthn](/maintainers/rsthn)

---

Top Contributors

[![strikeone88](https://avatars.githubusercontent.com/u/50781762?v=4)](https://github.com/strikeone88 "strikeone88 (89 commits)")[![rsthn](https://avatars.githubusercontent.com/u/40846185?v=4)](https://github.com/rsthn "rsthn (3 commits)")

### Embed Badge

![Health badge](/badges/rsthn-rose-api/health.svg)

```
[![Health](https://phpackages.com/badges/rsthn-rose-api/health.svg)](https://phpackages.com/packages/rsthn-rose-api)
```

###  Alternatives

[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)