nypl/microservice-starter

NYPL Microservice Starter

Monday, July 30, 2018
by kfriedman
Repository
22 Watchers
4 Stars
1,404 Installations

PHP
0 Dependents
0 Suggesters
2 Forks
5 Open issues
100 Versions
6 % Grown

The README.md

NYPL PHP Microservice Starter

This package is intended to be used as the starter package for PHP-based NYPL Microservices., _(*1)

This package adheres to PSR-1, PSR-2, and PSR-4 (using the Composer autoloader)., _(*2)

Deployment

This library is intended to be used as a Composer dependency hosted on Packagist. To deploy a new version, create a numeric tag, like "2.0.0" and push it up to Github. Then, log into Packagist and hit the update button to pull in the new tag. This will make your new tag available as a Composer dependency version that your apps can access., _(*3)

Installation

Via Composer, _(*4)

"require": {
    "nypl/microservice-starter": "^2.0.0"
}

Requirements

PHP >= 8.3
PHP Extensions
- Rdkafka

Features

RESTful HTTP framework (Slim)
Database PDO library (Slim-PDO)
Kafka message publishing (Rdkafka)
Avro serializer (Avro)
Swagger documentation generator (swagger-php)
Error logging (Monolog)
Identity/JWT authentication via NYPL API Gateway (X-NYPL-Identity)

Usage

HTTP/API Server

See the samples/service directory to learn how to create an example service., _(*5)

Basic Example

Create an index.php with a Service object and your Slim routes:, _(*6)

$service = new NYPL\Starter\Service();

$service->get("/v0.1/bibs", function (Request $request, Response $response) {
    $controller = new Controller\BibController($request, $response);
    return $controller->getBibs();
});

Configure your web server to load index.php on all requests. See the samples/service-config directory for sample configuration files for an Apache .htaccess or Nginx nginx.conf installation., _(*7)

Swagger Documentation Generator

Create a Swagger route to generate Swagger specification documentation:, _(*8)

$service->get("/swagger", function (Request $request, Response $response) {
    return SwaggerGenerator::generate(__DIR__ . "/src", $response);
});

Forked Avro library

A fork of the Avro PHP library is included in this repo. See the Avro README for details., _(*9)

The Versions

30/07 2018

dev-debug-kinesis

NYPL Microservice Starter

library microservice-starter

NYPL Microservice Starter

nypl/microservice-starter

The README.md

NYPL PHP Microservice Starter

Deployment

Installation

Requirements

Features

Usage

HTTP/API Server

Basic Example

Swagger Documentation Generator

Forked Avro library

The Versions

dev-debug-kinesis

The Requires

by Kevin Friedman

dev-master

The Requires

by Kevin Friedman

1.2.14

The Requires

by Kevin Friedman

1.2.13

The Requires

by Kevin Friedman

1.2.12

The Requires

by Kevin Friedman

1.2.11

The Requires

by Kevin Friedman

1.2.10

The Requires

by Kevin Friedman

1.2.9

The Requires

by Kevin Friedman

1.2.8

The Requires

by Kevin Friedman

1.2.7

The Requires

by Kevin Friedman

1.2.6

The Requires

by Kevin Friedman

1.2.5

The Requires

by Kevin Friedman

dev-show-total-count

The Requires

by Kevin Friedman

dev-refactor-success-response

The Requires

by Kevin Friedman

dev-include-count

The Requires

by Kevin Friedman

1.2.4

The Requires

by Kevin Friedman

1.1.x-dev

The Requires

by Kevin Friedman

1.1.43

The Requires

by Kevin Friedman

1.2.3

The Requires

by Kevin Friedman

1.2.2

The Requires

by Kevin Friedman

1.2.1

The Requires

by Kevin Friedman

1.2.0

The Requires