Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • ci-test
  • v0.1.4
  • v0.1.3
  • v0.1.2
  • v0.1.1
  • v0.1.0
7 results
Blame Permalink
  • Reiter, Christoph's avatar
    413a941b
    Remove the starter bundle · 413a941b
    Reiter, Christoph authored 
    While the starter bundle gives a nice example for how to integrate an API
it makes setting up a new server harder because the user usually already
has a bundle in mind that he/she wants to add.

So remove it and instead make it easier to add bundles by improving the docs
    413a941b
    History
    Remove the starter bundle
    Reiter, Christoph authored 
    While the starter bundle gives a nice example for how to integrate an API
it makes setting up a new server harder because the user usually already
has a bundle in mind that he/she wants to add.

So remove it and instead make it easier to add bundles by improving the docs
README.md 1.07 KiB

DBP API Server Template

This repository can be used as a template/starting point for your own API instance. It consists of a minimally configures Symfony application and development environment and includes/integrates:

  • The dbp/api-core-bundle: Which provides authentication, some same base end points and entities and configuration for api-platform
  • A docker-compose based development environment
  • Linter/Unittest integration

Documentation

The documentation is work in progress and currently exists in another repository which can be viewed here: https://api.tugraz.at/docs/index.html

It will be moved into this repository in the near future.

Creating your own API instance and creating your own Bundle

  • Fork this repository
  • Run the docker-compose based development environment and test it
  • Copy the "api-starter-bundle" repo and rename everything
  • Add the new bundle to your API fork

Development

Please open docker-dev/README.md for more information.