Documentation for REST API benchmark kit

Author: steevanb

README.md

@@ -8,7 +8,7 @@ Benchmark kit is a tool to add a framework or a template engine benchmark on [ph
 
 Documentation
 -
-
+ * [Changelog](changelog.md)
  * [Understand repositories and branches](documentation/repositoriesAndBranches.md)
 
 Requirements
@@ -26,7 +26,7 @@ Installation
 # you can install it where you want, ~/benchmarkKit used for the example
 mkdir ~/benchmarkKit
 cd ~/benchmarkKit
-echo '{"require": {"phpbenchmarks/benchmark-kit": "^2.0"}}' > composer.json
+echo '{"require": {"phpbenchmarks/benchmark-kit": "^3.0"}}' > composer.json
 
 # you can use your local composer installation, of the official Docker container
 docker run --rm -v $(pwd):/app composer/composer update --no-dev
@@ -101,7 +101,8 @@ You can call `configure:all` to create all of them, or use the one your need.
 
 Note the `phpbench composer:update` command. We need a `composer.lock` per PHP version,
 because some dependencies are installed in different versions depending on the version of PHP.
-Use `phpbench composer:update` to switch between PHP version, and create `composer.lock.phpX.Y`.
+
+Use `phpbench composer:update` to switch between PHP version, and create `.phpbenchmarks/composer.lock.phpX.Y`.
 
 ```bash
 phpbench composer:update
@@ -116,7 +117,7 @@ Choose the component type and benchmark type you want to code:
 
 * Framework
   * [Hello world benchmark](documentation/framework/helloWorld.md)
-  * REST API benchmark (coming soon)
+  * [REST API benchmark](documentation/framework/restApi.md)
 * Template engine
   * Hello world benchmark (coming soon)
 

changelog.md

@@ -0,0 +1,8 @@
+### [3.0.0](../../compare/2.0.0...3.0.0) - 2018-04-28
+
+- Move `composer.lock.php*` to .phpbenchmarks directory.
+- Add REST API documentation and kit.
+
+### [2.0.0](../../compare/1.0.6...2.0.0) - 2018-01-20
+
+- Bash scripts are transformed into PHP commands.

documentation/framework/restApi.md

@@ -0,0 +1,26 @@
+REST API benchmark
+-
+
+This benchmark respresent a REST API application.
+
+It contains 500 routes, 15,000 translations and return 100 PHP objects serialized in JSON.
+
+An event is triggered to randomly define language and benchmark event dispatcher.
+
+No database access is made, to not influence the results.
+
+Features
+-
+
+Don't forget this features as to be coded in [common repository](../repositoriesAndBranches.md).
+
+* A route with the url `benchmark/rest`. Is should be the first defined route. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_rest-api/Resources/config/routing.yml).
+* 500 other routes with the url `/benchmark/test-route-x`, defined after the first one. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_rest-api/Resources/config/routing.yml).
+* A controller called by the url `benchmark/rest`. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_rest-api/Controller/RestApiController.php).
+  * Trigger an event to randomly define language. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_rest-api/Controller/RestApiController.php).
+  * This event should randomly define language between `fr_FR`, `en_GB` and `en` (to use fallback system). [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_rest-api/EventListener/DefineLocaleEventListener.php).
+  * Serialize the return of `PhpBenchmarksRestData\Service\Service::getUsers()` into json. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_rest-api/Normalizer/UserNormalizer.php).
+  * Return this json in response body with `Content-Type: application/json` header. [Example](https://github.com/phpbenchmarks/symfony-common/blob/symfony_4_rest-api/Controller/RestApiController.php).
+* 5,000 translations by language (`fr_FR`, `en_GB` and `en` so 15,000 translations in total). [Example](https://github.com/phpbenchmarks/laravel-common/blob/laravel_5_rest-api/Resources/lang/en_GB/phpbenchmarks.php).
+
+[Back to documentation index](../../README.md)