kzorluoglu/rest-api-bundle

A Symfony bundle for Chameleon System

dev-master 2021-04-09 13:27 UTC

Requires

• php: ^7.4
• ext-json: *
• ext-pdo: *
• chameleon-system/chameleon-base: 7.1.x@dev
• zircote/swagger-php: ^3.1

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Koray Zorluoglu

• symfony
• rest
• api
• bundle

README

This bundle provide REST API interface for Chameleon Shop. All Business-Features (not yet) be possible.

Actually Completed Features:

• Login
• Basic Product List with sorting, offset and limit

installation

• Install the Bundle via Composer

 composer.sh require kzorluoglu/rest-api-bundle:dev-master

• Add the Bundle in app/AppKernel.php

new \kzorluoglu\RestApiBundle\kzorluogluRestApiBundle(),

• Add the AnnotationReader::addGlobalIgnoredNamespace("OA") in app/autoload.php

$loader = require __DIR__.'/../vendor/autoload.php';

// OA (open AI) Annotations adding Doctorine Ingored Namespaces List
\Doctrine\Common\Annotations\AnnotationReader::addGlobalIgnoredNamespace("OA");

• Add the API Route in app/config/routing.yml

api:
    resource: "@kzorluogluRestApiBundle/Resources/config/routing.yml"
    type:     yaml
    prefix:   /api

Documentation for API Endpoints

All URIs are relative to https://demo.chameleon-system.de/

Class	Method	HTTP request	Description
DefaultApi	kzorluogluRestApiBundleControllerLoginControllerLogin	POST /api/login	Login as user
DefaultApi	kzorluogluRestApiBundleControllerProductProductControllerIndex	POST /api/product	Product List

Documentation For Models

• LoginBody
• Product Body
• Login Response (Status Code: 200)
• Product Response (Status Code: 200)

Tests

Prepare

cd /vendor/kzorluoglu/rest-api-bundle
composer install

and Run Tests

./vendor/bin/phpunit -c phpunit.xml

Development

Create a new openapi yaml after changes

./vendor/bin/openapi -o api.yml  /your/root/path/vendor/kzorluoglu/rest-api-bundle/Controller

Example:

./vendor/bin/openapi -o api.yml  /usr/local/apache2/htdocs/customer/vendor/kzorluoglu/rest-api-bundle/Controller

1. Check if api.yml exists

../customer
..../app
..../web
..../api.yml

1. For Preview; copy the contents of the api.yml file and paste it on https://editor.swagger.io

Documentation generating

Preview

1. copy the contents of the api.yml file
2. paste it on https://editor.swagger.io

Alternative 1

1. Copy the contents of the api.yml file and paste it on https://editor.swagger.io
2. Click Generate Client
3. Choose one of the Client Software Language
4. extract the generated zip file
5. copy the "## Documentation for API Endpoints" Section from readme.md in your readme.md
6. copy the docs folder from zip to this bundle

Alternative 2

1. Download https://github.com/swagger-api/swagger-ui - folder of interest is "dist"
2. Copy your api YAML into the dist folder
3. Open index.html and change the value of URL inside the tag at the bottom of the file to ./swagger.json (or whatever your swagger json is called)
4. Host online! (or start a local server to view output).