https://github.com/sirn-se/phrity-slim-openapi

[php-lib] OpenApi implementation for Slim 4
https://github.com/sirn-se/phrity-slim-openapi

openapi php php-library slim slim-framework

Last synced: about 1 month ago
JSON representation

[php-lib] OpenApi implementation for Slim 4

• Host: GitHub
• URL: https://github.com/sirn-se/phrity-slim-openapi
• Owner: sirn-se
• Created: 2020-07-07T10:08:45.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-06-21T20:30:16.000Z (over 1 year ago)
• Last Synced: 2024-09-30T15:11:50.859Z (about 2 months ago)
• Topics: openapi, php, php-library, slim, slim-framework
• Language: PHP
• Homepage:
• Size: 63.5 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/sirn-se/phrity-slim-openapi/actions/workflows/acceptance.yml/badge.svg)](https://github.com/sirn-se/phrity-slim-openapi/actions)

[![Coverage Status](https://coveralls.io/repos/github/sirn-se/phrity-slim-openapi/badge.svg?branch=master)](https://coveralls.io/github/sirn-se/phrity-slim-openapi?branch=master)

# OpenApi for Slim v4

Adapter that reads [OpenApi](https://spec.openapis.org) schema and add included routes to [Slim](https://www.slimframework.com).

By defining `operationId` in OpenApi schema, the adapter will automatically instanciate and call referenced controller class.

Some features

- Automatic mapping of routes to controllers

- OpenApi specification in JSON or YAML source

- Optional validation of requests and responses

## Installation

Install with [Composer](https://getcomposer.org/);

```

composer require phrity/slim-openapi

```

## How to use

```php

use Phrity\Slim\OpenApi;

use Slim\Factory\AppFactory;

// Create Slim App as you normally would

$slim = AppFactory::create();

// Create OpenApi adapter with OpenApi source

$openapi = new OpenApi('openapi.json');

// Push all routes from OpenApi to Slim

$openapi->route($slim);

// Run Slim

$slim->run();

```

## How to define controllers

In order for automatic mapping to work, the `operationId` must be set on all defined routes in OpenApi source.

If no method is specified, class method `__invoke()` will be called on class.

| With invoke | With method |

| --- | --- |

| `Classname` | `Classname:method` |

| `Namespace/Classname` | `Namespace/Classname:method` |

| `Namespace\\Classname` | `Namespace\\Classname:method` |

### Example

```json

{

    "openapi": "3.0.0",

    "paths": {

        "/test": {

            "get": {

                "operationId": "Test/MyController",

                "description": "Will invoke on class Test\\MyController"

            },

            "put": {

                "operationId": "Test\\MyController:put",

                "description": "Will call method put() on class Test\\MyController"

            }

        }

    }

}

```

# Documentation

- [Basics](docs/Basics.md)

- [Settings](docs/Settings.md)

- [Validation](docs/Validation.md)

- [Extras](docs/Extras.md)

## Versions

| Version | PHP | |

| --- | --- | --- |

| `1.2` | `^7.4\|^8.0` | Request/Response validation, YAML support |

| `1.1` | `^7.4\|^8.0` | Settings & helpers |

| `1.0` | `^7.4\|^8.0` | Route registry |