public function getDocumentation()
{
$doc = new Documentation\Version();
$resource = new Resource(Resource::STATUS_CLOSED, $this->context->get(Context::KEY_PATH));
$resource->addMethod(Resource\Factory::getMethod('GET')->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Collection')));
$resource->addMethod(Resource\Factory::getMethod('POST')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Create'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$resource->addMethod(Resource\Factory::getMethod('PUT')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Update'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$resource->addMethod(Resource\Factory::getMethod('DELETE')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Delete'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$doc->addResource(1, $resource);
$resource = new Resource(Resource::STATUS_DEPRECATED, $this->context->get(Context::KEY_PATH));
$resource->addMethod(Resource\Factory::getMethod('GET')->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Collection')));
$resource->addMethod(Resource\Factory::getMethod('POST')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Create'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$resource->addMethod(Resource\Factory::getMethod('PUT')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Update'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$resource->addMethod(Resource\Factory::getMethod('DELETE')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Delete'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$doc->addResource(2, $resource);
$resource = new Resource(Resource::STATUS_ACTIVE, $this->context->get(Context::KEY_PATH));
$resource->setTitle('foo');
$resource->setDescription('lorem ipsum');
$resource->addPathParameter(Property::getString('name')->setDescription('Name parameter')->setRequired(false)->setMinLength(0)->setMaxLength(16)->setPattern('[A-z]+'));
$resource->addPathParameter(Property::getString('type')->setEnumeration(['foo', 'bar']));
$resource->addMethod(Resource\Factory::getMethod('GET')->setDescription('Returns a collection')->addQueryParameter(Property::getInteger('startIndex')->setDescription('startIndex parameter')->setRequired(false)->setMin(0)->setMax(32))->addQueryParameter(Property::getFloat('float'))->addQueryParameter(Property::getBoolean('boolean'))->addQueryParameter(Property::getDate('date'))->addQueryParameter(Property::getDateTime('datetime'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Collection')));
$resource->addMethod(Resource\Factory::getMethod('POST')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Create'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$resource->addMethod(Resource\Factory::getMethod('PUT')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Update'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$resource->addMethod(Resource\Factory::getMethod('DELETE')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Delete'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$doc->addResource(3, $resource);
return $doc;
}
public function getDocumentation()
{
$resource = new Resource(Resource::STATUS_ACTIVE, $this->context->get(Context::KEY_PATH));
$resource->addPathParameter(Property::getInteger('fooId'));
$resource->addMethod(Resource\Factory::getMethod('GET')->addQueryParameter(Property::getInteger('startIndex'))->addQueryParameter(Property::getInteger('count'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Collection')));
$resource->addMethod(Resource\Factory::getMethod('PUT')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Update'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
$resource->addMethod(Resource\Factory::getMethod('DELETE')->setRequest($this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\Delete'))->addResponse(200, $this->schemaManager->getSchema('PSX\\Controller\\Foo\\Schema\\SuccessMessage')));
return new Documentation\Simple($resource);
}
public function testResource()
{
$resource = new Resource(Resource::STATUS_ACTIVE, '/foo');
$resource->setTitle('foobar');
$resource->setDescription('foobar');
$resource->addPathParameter(Property::getString('foo'));
$resource->addMethod(Factory::getMethod('GET'));
$this->assertEquals(Resource::STATUS_ACTIVE, $resource->getStatus());
$this->assertTrue($resource->isActive());
$this->assertFalse($resource->isDeprecated());
$this->assertFalse($resource->isClosed());
$this->assertEquals('/foo', $resource->getPath());
$this->assertEquals('foobar', $resource->getTitle());
$this->assertEquals('foobar', $resource->getDescription());
$this->assertInstanceOf('PSX\\Data\\SchemaInterface', $resource->getPathParameters());
$this->assertInstanceOf('PSX\\Api\\Resource\\MethodAbstract', $resource->getMethod('GET'));
$this->assertEquals(['GET' => $resource->getMethod('GET')], $resource->getMethods());
$this->assertEquals(['GET'], $resource->getAllowedMethods());
$this->assertTrue($resource->hasMethod('GET'));
$this->assertFalse($resource->hasMethod('POST'));
}
protected function parseUriParameters(Resource $resource, array $data)
{
if (isset($data['uriParameters']) && is_array($data['uriParameters'])) {
foreach ($data['uriParameters'] as $name => $definition) {
if (!empty($name) && is_array($definition)) {
$resource->addPathParameter($this->getParameter($name, $definition));
}
}
}
}
