fae/api-primer

API primer with REST endpoints using FAE framework

v1.0.0 2021-02-17 11:41 UTC

Requires

• fae/auth_oidc: ^1.2.1
• fae/fields: 0.*
• fae/graphql: ^1.3
• fae/idseq: >=0.3
• fae/rest: ^1.0
• fae/schema: ^0.2.10
• fae/user: ^2.1
• symfony/dotenv: ^5.1

Requires (Dev)

• phpunit/phpunit: ^8.5

LGPL-2.1-or-later

• Callum Smith

README

A skeleton project with all the necessary folders and bits to make a REST API

Next steps

You will want to start by modifying the name of your first frame to something that makes sense to you. The intention of a frame is to keep a single module within your API separate from others. This gives you the opportunity to split each frame out into a component composer module in the future should you require the same functionality in another microservice.

A frame does not need to be an MVC component, and can in fact be something that provides very different functionality, such as authentication mechanisms or any generic component.