Updated changelog, readme and upgrade, removed method addApiHandler

Author: lulco

CHANGELOG.md

@@ -6,13 +6,14 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 #### Changed
 
-* Update nette libs to version 3.0.0 (BC break)
+* Updated nette libs to version 3.0.0 (BC break)
 * Added typehints (BC break)
 * Splitted InputParam to multiple subclasses (BC break)
 * Removed type TYPE_POST_JSON_KEY (BC break)
 * Wrong input now returns code 400 instead of 500 (BC break if somebody checks return code)
+* Replaced handler information array triplet (endpoint, handler, authorization) with class Api (BC break for API console usage)
+* Renamed some methods from ApiDecider (BC break)
 * Pretty JSON output in API console - without escaping unicode and slashes
-* Replaced handler information array triplet (endpoint, handler, authorization) with Api
 
 #### Added
 
@@ -24,13 +25,13 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 #### Removed
 
 * Removed support for PHP 5.6, 7.0 and hhvm (BC Break)
+* Removed deprecated class ApiResponse (BC Break)
 
 ## 1.15.0 - 2019-03-13
 
 #### Added
 
 * Added possibility to set own scope to Manager
-
 * Added JSON validation - if JSON is invalid, throw "wrong input" error instead of setting params to null
 
 ## 1.14.0 - 2018-08-02

README.md

@@ -12,7 +12,7 @@
 
 ## Why Nette-Api
 
-This library provides out-of-the box API solution for Nette framework. You can register API endpoints and connect it to specified handlers. You need only implement you custom business logic. Library provide authorization, validation and formatting services for you API.
+This library provides out-of-the box API solution for Nette framework. You can register API endpoints and connect it to specified handlers. You need only implement your custom business logic. Library provides authorization, validation and formatting services for you API.
 
 ## Installation
 
@@ -21,7 +21,7 @@ This library requires PHP 7.1 or later.
 Recommended installation method is via Composer:
 
 ```bash
-$ composer require tomaj/nette-api
+composer require tomaj/nette-api
 ```
 
 Library is compliant with [PSR-1][], [PSR-2][], [PSR-3][] and [PSR-4][].
@@ -33,7 +33,7 @@ Library is compliant with [PSR-1][], [PSR-2][], [PSR-3][] and [PSR-4][].
 
 ## How Nette-API works
 
-First you have register library presenter for routing. In *config.neon* just add this line:
+First, you have to register library presenter for routing. In *config.neon* just add this line:
 
 ```neon
 application:
@@ -47,7 +47,7 @@ And add route to you RouterFactory:
 $router[] = new Route('/api/v<version>/<package>[/<apiAction>][/<params>]', 'Api:Api:default');
 ```
 
-After that you need only register your api handlers to *apiDecider* [ApiDecider](src/ApiDecider.php) and register [ApiLink](src/Link/ApiLink.php) and [Tomaj\NetteApi\Misc\IpDetector](src/Misc/IpDetector.php). This can be done also with *config.neon*:
+After that you need only register your API handlers to *apiDecider* [ApiDecider](src/ApiDecider.php), register [ApiLink](src/Link/ApiLink.php) and [Tomaj\NetteApi\Misc\IpDetector](src/Misc/IpDetector.php). This can be done also with *config.neon*:
 
 ```neon
 services:
@@ -67,13 +67,13 @@ This example will prepare these API calls:
 2. `http://yourapp/api/v1/users/send-email`  - available via POST
 
 
-Core of the Nette-Api are handlers. For this example you need implement 2 classes:
+Core of the Nette-Api are handlers. For this example you need to implement two classes:
 
 1. App\MyApi\v1\Handlers\UsersListingHandler
 2. App\MyApi\v1\Handlers\SendEmailHandler
 
-These handlers implement interface *[ApiHandlerInterface](src/Handlers/ApiHandlerInterface.php)* but for easier usage you can extends your handlers from [BaseHandler](src/Handlers/BaseHandler.php). 
-When someone reach your API this handlers will be triggered and *handle()* method will be called.
+These handlers implement interface *[ApiHandlerInterface](src/Handlers/ApiHandlerInterface.php)* but for easier usage you can extend your handlers from [BaseHandler](src/Handlers/BaseHandler.php). 
+When someone reach your API these handlers will be triggered and *handle()* method will be called.
 
 ```php
 namespace App\MyApi\v1\Handlers;
@@ -108,13 +108,13 @@ This simple handler is using *UsersRepository* that was created by Nette Contain
 ## Advanced use (with Fractal)
 
 Nette-Api provides integration with [Fractal][] library for formatting API responses.
-If you want to use it, you have to extend your handler from *[BaseHandler](src/Handlers/BaseHandler.php)* and your Fractal instance will be accessible be `$this->getFractal()`.
+If you want to use it, you have to extend your handler from *[BaseHandler](src/Handlers/BaseHandler.php)* and your Fractal instance will be accessible by `$this->getFractal()`.
 
-Main advantage from Fractal is separation your api "view" (like transformation data to json object or xml or anything...). Also you can include transformations in other transformations to include other objects to others. 
+Main advantage of Fractal is separation of your API "view" (like transformation data to json object or xml or anything...). Also you can include transformations in other transformations to include other objects to others. 
 
 Example with fractal:
 
-1. You will need Formater
+1. You will need Transformer
 
 ```php
 namespace App\MyApi\v1\Transformers;
@@ -165,13 +165,13 @@ class UsersListingHandler extends Basehandler
 }
 ```
 
-I have to recommend to take a look at [Fractal][] library. There are much more information about transformers, serialisers, paginations etc. It is really nice library.
+We recommend to take a look at [Fractal][] library. There are much more information about transformers, serializers, paginations etc. It is really nice library.
 
 [Fractal]: http://fractal.thephpleague.com/
 
 ## Endpoint inputs
 
-Each handler can describe which input is required. It could be GET or POST parameters, also COOKIES, raw post json or file uploads. You have to implement method `params()` where you have to return array with params. This params are used in api console to generate right form.
+Each handler can describe which input is required. It could be GET or POST parameters, also COOKIES, raw post, JSON or file uploads. You have to implement method `params()` where you have to return array with params. These params are used in API console to generate form.
 
 Example with user detail:
 
@@ -217,26 +217,26 @@ class UsersDetailHandler extends Basehandler
 
 ## Input Types
 
-Nette-Api provides various InputParam types. You can send params with GET, POST, COOKIES, FILES or RAW POST data.
+Nette-Api provides various InputParam types. You can send params with GET, POST, COOKIES, FILES, RAW POST data or JSON.
 All input types are available via test console.
 
-This is table with support input types:
+This is table with supported input types:
 
 | Input type      | Example
 | ----------      | -------
-| POST            | `new PostInputParam('key')`
 | GET             | `new GetInputParam('key')`
-| FILE            | `new FileInputParam('key')`
+| POST            | `new PostInputParam('key')`
 | COOKIE          | `new CookieInputParam('key')`
+| FILE            | `new FileInputParam('key')`
 | RAW POST        | `new RawInputParam('key')`
 | JSON            | `new JsonInputParam('key', '{"type": "object"}')`
 
 
 ## Security
 
-Protecting your api is easy with Nette-Api. You have to implement your [Authorization](src/Authorization/ApiAuthorizationInterface.php) (Tomaj\NetteApi\Authorization\ApiAuthorizationInterface) and add it as third argument to *addApi()* method in *config.neon*.
+Protecting your API is easy with Nette-Api. You have to implement your [Authorization](src/Authorization/ApiAuthorizationInterface.php) (Tomaj\NetteApi\Authorization\ApiAuthorizationInterface) and add it as third argument to *addApi()* method in *config.neon*.
 
-For simple use, if you want to use Bearer token authorisation with few tokens, you can use [StaticBearerTokenRepository](src/Misc/StaticBearerTokenRepository.php) (Tomaj\NetteApi\Misc\StaticBearerTokenRepository).
+For simple use, if you want to use Bearer token authorization with few tokens, you can use [StaticBearerTokenRepository](src/Misc/StaticBearerTokenRepository.php) (Tomaj\NetteApi\Misc\StaticBearerTokenRepository).
 
 ```neon
 services:
@@ -293,7 +293,7 @@ services:
 
 ## Logging
 
-It is good practice to log you api access if you provide valuable information with your API. To enable logging you need to implement class with interface [ApiLoggerInterface](src/Logger/ApiLoggerInterface.php) (Tomaj\NetteApi\Logger\ApiLoggerInterface) and register it as service in *config.neon*. It will be automatically wired and called after execution of all api requests.
+It is good practice to log you api access if you provide valuable information with your API. To enable logging you need to implement class with interface [ApiLoggerInterface](src/Logger/ApiLoggerInterface.php) (Tomaj\NetteApi\Logger\ApiLoggerInterface) and register it as service in *config.neon*. It will be automatically wired and called after execution of all API requests.
 
 ## CORS Security
 

UPGRADE.md

@@ -3,11 +3,11 @@
 ## Upgrade from 1.x to 2.0.0
 
 ### Splitted InputParam to multiple subclasses
-InputParam is now abstract class and all types have their own class. Also InputParam is more like Nette Form inputs with fluent API
+InputParam is now abstract class and all types have their own classes. Also InputParam is more like Nette Form inputs with fluent API.
 
 Examples of replacements:
 
-Requred get input with available values:
+Required GET input with available values:
 
 Old:
 ```php
@@ -19,7 +19,7 @@ New:
 (new GetInputParam('status'))->setRequired()->setAvailableValues(['ok', 'error'])
 ```
 
-Multiple optional file input:
+Multiple optional FILE input:
 
 Old:
 ```php
@@ -31,14 +31,16 @@ New:
 (new FileInputParam('myfile'))->setMulti()
 ```
 
+For more info about types, see readme section Input Types.
+
 ### Removed support for old PHP versions
-New version not supported PHP versions 5.6 and 7.0 and also hhvm. Please use it with newer versions of PHP (>7.1)
+New version does not support PHP versions 5.6 and 7.0 and also hhvm. Please use it with newer versions of PHP (>7.1)
 
 ### Updated dependencies
-Version 2.0.0 requires nette packages in version 3.0, so probably you will have to upgrade whole your nette application 
+Version 2.0.0 requires nette packages in version 3.0, so probably you will have to upgrade whole nette application.
 
 ### Typehints
-There are some breaking changes because of typehints:
+There are some breaking changes because of added typehints:
 
 #### ApiAuthorizationInterface
 Add typehints to methods:
@@ -92,6 +94,9 @@ BaseHandler now have few final methods:
 - `setupLinkGenerator`
 - `createLink`
 
+### Removed class
+Class ApiResponse has been removed. Use JsonApiResponse instead.
+
 ### Removed params
 Parameters $parent and $name have been removed from ApiListingControl. New usage is:
 ```php
@@ -102,10 +107,10 @@ new ApiListingControl($apiDecider)
 Some parameters were strictly typed:
 - second parameter in `JsonApiResponse::__construct` (`$payload` formerly known as `$data`) is now `array`
 - fifth parameter in `JsonApiResponse::__construct` (`$expiration`) is now `DateTimeInteface` or `null`
-- fourth parameter in `InputParam::__construct` (`$availableValues`) is now `array` or `null`
+- fourth parameter in `InputParam::__construct` (`$availableValues`, now parameter of method `setAvailableValues()`) is now `array`
 
 ### Changed events
-Registration of event onClick in ApiListingControl.
+Registration of event onClick in ApiListingControl has been changed.
 Use:
 ```php
 $apiListing->onClick[] = function ($method, $version, $package, $apiAction) {
@@ -115,5 +120,6 @@ $apiListing->onClick[] = function ($method, $version, $package, $apiAction) {
 
 ### Features
 With new version of Nette API you can:
-- add description for your API handlers, also you can mark some handlers as deprecated and add tags for them.
-- add description, default value and example for all your input params
+- add description to your API handlers, also you can mark some handlers as deprecated and add tags for them.
+- add description, default value and example for all your input params.
+- add list of possible outputs which are validate before response is sent to user. If output is not valid, error is sent.

src/ApiDecider.php

@@ -55,14 +55,6 @@ public function enableGlobalPreflight(ApiHandlerInterface $corsHandler = null)
         $this->globalPreflightHandler = $corsHandler;
     }
 
-    /**
-     * @deprecated use addApi instead
-     */
-    public function addApiHandler(EndpointInterface $endpointIdentifier, ApiHandlerInterface $handler, ApiAuthorizationInterface $apiAuthorization)
-    {
-        return $this->addApi($endpointIdentifier, $handler, $apiAuthorization);
-    }
-
     /**
      * Register new api handler
      *