Download the PHP package robinscholz/better-rest without Composer
On this page you can find all versions of the php package robinscholz/better-rest. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download robinscholz/better-rest
More information about robinscholz/better-rest
Files in robinscholz/better-rest
Package better-rest
Short Description Kirby Plugin for better REST requests
License MIT
FAQ
Example:
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 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.
Informations about the package better-rest
🤝 Better REST
A Kirby plugin that exposes the internal REST API at /rest with the option to convert Kirbytags to HTML and add a srcset to images in the process. Intended to convert Kirby into a headless CMS.
Disclaimer
While this plugin is still functional, quite a few alternatives exist for turning Kirby into a headless content management system. If you are looking for a more sophisticated and modern solution, please take a look at the Kirby Query Language plugin, the recent work of Johann Schopplich or Kirby Content Representations.
Usage
The API can be accessed at /rest. The plugin only allows GET requests.
Authentification
Requests need to be authenticated via Basic Auth. It’s recommended to create a seperate API User with either a custom blueprint or with the one provided by this plugin called better-rest API. Read more about user roles in the docs.
Basic Auth needs to be enabled in the site/config/config.php:
Kirby 3 API
Examples:
rest/pages/:id: https://getkirby.com/docs/reference/api/pagesrest/site: https://getkirby.com/docs/reference/api/siterest/users/:id: https://getkirby.com/docs/reference/api/users
Better-Rest Settings from Query
All standard setting as well as settings defined in site/config/onfig.php can be overwritten on a per-request basis. Simply prefix the setting with br- and include it as a query.
Examples:
rest/pages/test?br-srcset=375,1200: br-srcsetrest/pages/test?br-smartypants=1: br-smartypantsrest/pages/test?br-language=fr: br-languagerest/pages/test?br-kirbytags=0&br-srcset=0: br-kirbytag br-srcset
Multilang
The plugin supports multiple language settings. To fetch content for a specific language include a X-Language header containing the desired language code with your request. Alternatively a br-language query can be used.
Settings
Config File
- The plugin converts kirbytags to HTML and adds a
srcsetto images by default. - Additionally it is possible to enable smartypants.
- To overwrite the default language it is possible to set a language code.
All settings need to be prefixed with robinscholz.better-rest.!
| Settings | Default | Options |
|---|---|---|
| kirbytags | true |
boolean |
| smartypants | false |
boolean |
| srcset | [375, 667, 1024, 1680] |
Array or false |
| language | null |
null or string |
Caveats
HTTPS
The Kirby installation needs to be served with a TLS Certicificate via https.
Local setup
For local development use Laravel Valet or disable https in the site/config/config.php:
WARNING: Do not use this setting for production environments!
Installation
Download
Download and copy this repository to /site/plugins/better-rest.
Composer
Git submodule
Credits
A big thanks to @bnomei who refactored the initial source code into something extendable and future proof. If you are using this plugin please consider buying him a ☕!
License
MIT
