Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mixerapi/mixerapi

CakePHP API Plugin for REST + JSON API Development [READ-ONLY]
https://github.com/mixerapi/mixerapi

api cakephp cakephp-plugin php php-api php-api-server php-server rest rest-api restful

Last synced: 1 day ago
JSON representation

CakePHP API Plugin for REST + JSON API Development [READ-ONLY]

Host: GitHub
URL: https://github.com/mixerapi/mixerapi
Owner: mixerapi
License: other
Created: 2020-08-11T02:27:39.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-03-25T23:50:21.000Z (8 months ago)
Last Synced: 2024-09-20T01:40:21.817Z (about 2 months ago)
Topics: api, cakephp, cakephp-plugin, php, php-api, php-api-server, php-server, rest, rest-api, restful
Language: PHP
Homepage: https://mixerapi.com
Size: 93.8 KB
Stars: 40
Watchers: 6
Forks: 2
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        ![Logo](./assets/mixerapi.svg#gh-light-mode-only)



    A CakePHP Plugin for RESTful API Development





    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



Streamline development of modern RESTful APIs for your teams CakePHP project. Designed around a component-based

architecture, MixerAPI enables developers to pick and choose the functionality they need for developing REST APIs.

[Documentation](https://mixerapi.com) |

[Demo Application](https://demo.mixerapi.com) |

[Demo Source Code](https://github.com/mixerapi/demo)

## Features

- **Rapid Prototyping:** Scaffold your API in seconds with a custom Bake template geared towards modern REST architecture.

- **OpenAPI:** Automatically generates [OpenAPI](https://www.openapis.org/) from your existing code into

  [Swagger](https://swagger.io/) and [Redoc](https://redoc.ly/). Attributes provided, but not required.

- **Error Handling:** Handles exception rendering in XML or JSON.

- **Data Formats:** Formats responses in JSON, XML, HAL+JSON, or JSON-LD.

- **Integrations:** Integrates well with other CakePHP 4 compatible plugins.

- **Minimalist Configuration:** Built for developing, not writing YAML configurations. Most components require zero

  configuration files.

- **Non-opinionated:** Develop your way.

This is a read-only repository. Please submit issues and PRs to

[mixerapi/mixerapi-dev](https://github.com/mixerapi/mixerapi-dev)

For install steps head over to [https://mixerapi.com/install](https://mixerapi.com/install)

## MixerAPI Core Plugins

MixerAPI automatically installs the following plugins for your RESTful API project:

| Plugin | Description |

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

| [MixerApi/Bake](https://github.com/mixerapi/bake) | A custom bake template focused on creating RESTful CakePHP controllers in seconds |

| [MixerApi/CollectionView](https://github.com/mixerapi/collection-view) | A Collection View for displaying configurable pagination meta-data in JSON or XML collection responses |

| [MixerApi/ExceptionRender](https://github.com/mixerapi/exception-render) | Handles rendering entity validation errors and other exceptions for your API |

| [MixerApi/HalView](https://github.com/mixerapi/hal-view) | A Hypertext Application Language ([HAL+JSON](http://stateless.co/hal_specification.html)) View for CakePHP |

| [MixerApi/JsonLdView](https://github.com/mixerapi/json-ld-view) | A [JSON-LD](https://json-ld.org/) View for CakePHP |

| [SwaggerBake](https://github.com/cnizzardini/cakephp-swagger-bake) | A delightfully tasty tool for generating Swagger documentation with OpenApi 3.0.0 schema |

## Recommended Plugins

| Plugin                                                   | Description |

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

| [MixerApi/Crud](https://github.com/mixerapi/crud)        | A service provider for CRUD (Create/Read/Update/Delete) operations. Since this plugin uses the experimental CakePHP dependency injection it must be enabled separately. |

| [MixerApi/JwtAuth](https://github.com/mixerapi/jwt-auth) | A JWT authentication library for CakePHP supporting both HMAC (HS256 or HS512) and RSA (RS256 or RS512) with JSON Web Keys. |

| [Search](https://github.com/FriendsOfCake/search)        | Search provides a simple interface to create paginate-able filters for your CakePHP application. |