Download the PHP package sroehrl/scaffold-api without Composer

On this page you can find all versions of the php package sroehrl/scaffold-api. 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?

Informations about the package scaffold-api

neoan3 PHP api scaffolding

Quick & dirty api scaffolding as a result of a twitch.tv/neoan3 session

What is this?

Create your backend in seconds and add your endpoints via command line. You don't need a database, this tool ships with a file-based database for your convenience. However, you can easily add a database at any point.

Out of the box, you have

Installation

NOTE: requires neoan3-cli, PHP & composer to be globally available.

  1. composer create-project sroehrl/scaffold-api
  2. neoan3 develop

That's it, your project should run.

Usage

Within the project directory, run

php scaffold <yourAPIendpointName> to generate get & post endpoints.

Modifications (or additional methods) to the endpoint can be achieved by editing the generated model & component files. Look into neoan3 for specifics.

user model

This project already ships with a user model & endpoints.

To register

POST /api.v1/users

response format:

All generated calls require a JWT-token to be used.

to login

POST /api.v1/users/auth

expects same json-format (userName, password) as register, returns same format.

Examples

php scaffold posts

Generates the following endpoints:

POST /api.v1/posts creates new post

GET /api.v1/posts returns multiple posts; accepts optional parameters (e.g. ?title=first)

GET /api.v1/posts/:id retrieves a post

PUT /api.v1/posts/:id updates a post

The big picture

Instead of generating a pure test-api, the setup is meant to upcycle, meaning the structure is solid. You can build out actual database implementation while providing immediate usability.

All versions of scaffold-api with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4
ext-json Version *
mnsami/composer-custom-directory-installer Version 1.1.*
neoan3-apps/template Version ^1
neoan3-apps/db Version ^0.2.1
neoan3-model/index Version ^0.0.1
neoan3-apps/transformer Version ^1
neoan3-apps/file-away Version 1.0.0
neoan3-apps/stateless Version 1.0.*
neoan3-apps/ops Version 2.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 sroehrl/scaffold-api contains the following files

Loading the files please wait ....