README

Common schema for Yaga schedule requests. Swagger

This Symfony bundle is automatically generated by the Swagger Codegen project:

API version: 18.40.0
Build package: io.swagger.codegen.languages.SymfonyServerCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

To install the dependencies via Composer, add the following repository to composer.json of your Symfony project:

{
    "repositories": [{
        "type": "path",
        "url": "//Path to your generated swagger bundle"
    }],
}

Then run:

composer require swagger/server-bundle:dev-master

to add the generated swagger bundle as a dependency.

Tests

To run the unit tests for the generated bundle, first navigate to the directory containing the code, then run the following commands:

composer install
./vendor/bin/phpunit

Getting Started

Step 1: Please follow the installation procedure first.

Step 2: Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new YagaSchedule\Server\SwaggerServerBundle(),
        // ...
    );
}

Step 3: Register the routes:

# app/config/routing.yml
swagger_server:
    resource: "@SwaggerServerBundle/Resources/config/routing.yml"

Step 4: Implement the API calls:

<?php
// src/Acme/MyBundle/Api/YagaScheduleApiInterface.php

namespace Acme\MyBundle\Api;

use YagaSchedule\Server\Api\YagaScheduleApiInterface;

class YagaScheduleApi implements YagaScheduleApiInterface // An interface is autogenerated
{

    // Other operation methods ...
}

Step 5: Tag your API implementation:

# src/Acme/MyBundle/Resources/services.yml
services:
    # ...
    acme.my_bundle.api.yagaSchedule:
        class: Acme\MyBundle\Api\YagaScheduleApi
        tags:
            - { name: "swagger_server.api", api: "yagaSchedule" }
    # ...

Now you can start using the bundle!

Documentation for API Endpoints

All URIs are relative to https://localhost

Class	Method	HTTP request
YagaScheduleApiInterface	getCities	GET /cities
YagaScheduleApiInterface	getEvents	GET /events
YagaScheduleApiInterface	getHallplan	GET /hallplan
YagaScheduleApiInterface	getHalls	GET /halls
YagaScheduleApiInterface	getManifest	GET /manifest
YagaScheduleApiInterface	getOrganizers	GET /organizers
YagaScheduleApiInterface	getPersons	GET /persons
YagaScheduleApiInterface	getSchedule	GET /schedule
YagaScheduleApiInterface	getVenues	GET /venues

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

idesigning / yaga-schedule

Maintainers

Details