/**
* Returns a single swagger document from filesystem or crawl-generates
* a fresh one.
*
* @param string $id Name of the document
* @param string $host Hostname of system serving swagger documents (without protocol)
* @throws \InvalidArgumentException
* @return string
*/
public static function getSwaggerDocument($id, $host)
{
// load document from filesystem
$filePath = CACHE . self::$filePrefix . $id . '.json';
if (!Configure::read('Swagger.docs.crawl')) {
if (!file_exists($filePath)) {
throw new NotFoundException("Swagger json document was not found on filesystem: {$filePath}");
}
$fh = new File($filePath);
return $fh->read();
}
// otherwise crawl-generate a fresh document
$swaggerOptions = null;
if (Configure::read("Swagger.library.{$id}.exclude")) {
$swaggerOptions = ['exclude' => Configure::read("Swagger.library.{$id}.exclude")];
}
$swagger = \Swagger\scan(Configure::read("Swagger.library.{$id}.include"), $swaggerOptions);
// set object properties required by UI to generate the BASE URL
$swagger->host = $host;
if (empty($swagger->basePath)) {
$swagger->basePath = '/' . Configure::read('App.base');
}
$swagger->schemes = Configure::read('Swagger.ui.schemes');
// write document to filesystem
self::writeSwaggerDocumentToFile($filePath, $swagger);
return $swagger;
}
/**
* @SWG\Info(title="PHPWebDevelopers Api Store", version="0.0")
*/
public function indexAction()
{
$swagger = \Swagger\scan([APP_PATH . '/app/controllers']);
$response = $this->response;
$response->setStatusCode(Response::HTTP_STATUS_SUCCESS, "OK");
$response->setContent($swagger);
return $response;
}
/**
* @inheritdoc
*/
public function run()
{
Yii::$app->response->format = Response::FORMAT_JSON;
if (null !== $this->api_key && $this->api_key != Yii::$app->request->get($this->apiKeyParam)) {
return ['errcode' => 404, 'errmsg' => 'Permission denied'];
}
$swagger = \Swagger\scan($this->scanDir, $this->scanOptions);
return $swagger;
}
/**
* Akce pro vygenerování dokumentace
*/
public function actionJson()
{
//připravení JSON specifikace
$swaggerJson = \Swagger\scan(__DIR__);
//nahrazení použitých konstant
$swaggerJson = $this->replaceJsonVariables($swaggerJson);
$httpResponse = $this->presenter->getHttpResponse();
$httpResponse->setContentType('application/json');
$httpResponse->setHeader('Content-Disposition', 'inline; filename="swagger.json"');
$httpResponse->setHeader('Content-Length', strlen($swaggerJson));
echo $swaggerJson;
$this->terminate();
}
public function testThirdPartyAnnotations()
{
$backup = Analyser::$whitelist;
Analyser::$whitelist = ['Swagger\\Annotations\\'];
$analyser = new StaticAnalyser();
$analysis = $analyser->fromFile(__DIR__ . '/Fixtures/ThirdPartyAnnotations.php');
$this->assertCount(3, $analysis->annotations, 'Only read the @SWG annotations, skip the others.');
// Allow Swagger to parse 3rd party annotations
// might contain useful info that could be extracted with a custom processor
Analyser::$whitelist[] = 'Zend\\Form\\Annotation';
$swagger = \Swagger\scan(__DIR__ . '/Fixtures/ThirdPartyAnnotations.php');
$this->assertSame('api/3rd-party', $swagger->paths[0]->path);
$this->assertCount(10, $swagger->_unmerged);
Analyser::$whitelist = $backup;
}
public static function generateDocs()
{
$appDir = config('swagger-lume.paths.annotations');
$docDir = config('swagger-lume.paths.docs');
if (!File::exists($docDir) || is_writable($docDir)) {
// delete all existing documentation
if (File::exists($docDir)) {
File::deleteDirectory($docDir);
}
File::makeDirectory($docDir);
$excludeDirs = config('swagger-lume.paths.excludes');
$swagger = \Swagger\scan($appDir, $excludeDirs);
$filename = $docDir . '/api-docs.json';
$swagger->saveAs($filename);
}
}
public static function generateDocs()
{
$appDir = base_path() . "/" . Config::get('l5-swagger.app-dir');
$docDir = Config::get('l5-swagger.doc-dir');
if (!File::exists($docDir) || is_writable($docDir)) {
// delete all existing documentation
if (File::exists($docDir)) {
File::deleteDirectory($docDir);
}
File::makeDirectory($docDir);
$excludeDirs = Config::get('l5-swagger.excludes');
$swagger = \Swagger\scan($appDir, $excludeDirs);
$filename = $docDir . '/api-docs.json';
$swagger->saveAs($filename);
}
}
/**
* Method to handle API docs generation via Swagger.
*
* @todo Add swagger scan options
*
* @param Application $app
* @param Request $request
*
* @return Response
*/
public function __invoke(Application $app, Request $request)
{
// Get swagger options
$swaggerOptions = $app['vars']->get('swagger');
// Scan for Swagger documentation
$swagger = \Swagger\scan($swaggerOptions['servicePath'], []);
// Set some env specified parameters
$swagger->host = $request->getHttpHost();
$swagger->basePath = $request->getBasePath();
// Convert to JSON
$json = (string) $swagger;
// Create response
$response = Response::create($json, 200, ['Content-Type' => 'application/json']);
$response->setEtag(md5($json));
$response->isNotModified($request);
return $response;
}
public function testFullyQualifiedName()
{
$swagger = \Swagger\scan(__DIR__ . '/Fixtures/Customer.php');
$context = $swagger->definitions[0]->_context;
// resolve with namespace
$this->assertSame('\\FullyQualified', $context->fullyQualifiedName('\\FullyQualified'));
$this->assertSame('\\SwaggerFixures\\Unqualified', $context->fullyQualifiedName('Unqualified'));
$this->assertSame('\\SwaggerFixures\\Namespace\\Qualified', $context->fullyQualifiedName('Namespace\\Qualified'));
// respect use statements
$this->assertSame('\\Exception', $context->fullyQualifiedName('Exception'));
$this->assertSame('\\SwaggerFixures\\Customer', $context->fullyQualifiedName('Customer'));
$this->assertSame('\\Swagger\\Logger', $context->fullyQualifiedName('Logger'));
$this->assertSame('\\Swagger\\Logger', $context->fullyQualifiedName('lOgGeR'));
// php has case-insensitive class names :-(
$this->assertSame('\\Swagger\\Logger', $context->fullyQualifiedName('SwgLogger'));
$this->assertSame('\\Swagger\\Annotations\\QualifiedAlias', $context->fullyQualifiedName('SWG\\QualifiedAlias'));
}
public static function generateDocs()
{
$appDir = config('l5-swagger.paths.annotations');
$docDir = config('l5-swagger.paths.docs');
if (!File::exists($docDir) || is_writable($docDir)) {
// delete all existing documentation
if (File::exists($docDir)) {
File::deleteDirectory($docDir);
}
self::defineConstants(config('l5-swagger.constants') ?: []);
File::makeDirectory($docDir);
$excludeDirs = config('l5-swagger.paths.excludes');
$swagger = \Swagger\scan($appDir, ['exclude' => $excludeDirs]);
if (config('l5-swagger.paths.base') !== null) {
$swagger->basePath = config('l5-swagger.paths.base');
}
$filename = $docDir . '/' . config('l5-swagger.paths.docs_json', 'api-docs.json');
$swagger->saveAs($filename);
}
}
public function index()
{
// Define constants according to server environment
// Reference: https://github.com/zircote/swagger-php/blob/master/docs/Getting-started.md#using-variables-in-annotations
switch (ENVIRONMENT) {
case 'development':
define('API_HOST', $this->input->server('HTTP_HOST') . '/ci_bootstrap_3');
break;
case 'testing':
case 'production':
default:
define('API_HOST', '');
break;
}
// folders which include files with Swagger annotations
$module_dir = APPPATH . 'modules/' . $this->mModule;
$paths = array($module_dir . '/swagger', $module_dir . '/controllers');
$swagger = \Swagger\scan($paths);
// output JSON
header('Content-Type: application/json');
echo $swagger;
}
public function testThirdPartyAnnotations()
{
$backup = Analyser::$whitelist;
Analyser::$whitelist = ['Swagger\\Annotations\\'];
$analyser = new StaticAnalyser();
$defaultAnalysis = $analyser->fromFile(__DIR__ . '/Fixtures/ThirdPartyAnnotations.php');
$this->assertCount(3, $defaultAnalysis->annotations, 'Only read the @SWG annotations, skip the others.');
// Allow Swagger to parse 3rd party annotations
// might contain useful info that could be extracted with a custom processor
Analyser::$whitelist[] = 'Zend\\Form\\Annotation';
$swagger = \Swagger\scan(__DIR__ . '/Fixtures/ThirdPartyAnnotations.php');
$this->assertSame('api/3rd-party', $swagger->paths[0]->path);
$this->assertCount(10, $swagger->_unmerged);
Analyser::$whitelist = $backup;
$analysis = $swagger->_analysis;
$annotations = $analysis->getAnnotationsOfType('Zend\\Form\\Annotation\\Name');
$this->assertCount(1, $annotations);
$context = $analysis->getContext($annotations[0]);
$this->assertInstanceOf('Swagger\\Context', $context);
$this->assertSame('ThirdPartyAnnotations', $context->class);
$this->assertSame('\\SwaggerFixtures\\ThirdPartyAnnotations', $context->fullyQualifiedName($context->class));
$this->assertCount(2, $context->annotations);
}
public function __construct()
{
parent::__construct();
$app = $this;
// default config
$app['debug'] = true;
$app['http_cache'] = false;
$app['buzz.client'] = null;
$app['monolog.level'] = \Monolog\Logger::ERROR;
$app['redis.config'] = false;
// array('host' => 'localhost', 'port' => 6379);
$app['stats.config'] = ['enabled' => false];
$app['rate_limiting.config'] = ['enabled' => false, 'limit' => 3];
$app['proxy'] = false;
$app['proxy_server.address'] = null;
/// load config
$config = __DIR__ . '/../../config.php';
if (stream_resolve_include_path($config)) {
include $config;
}
// New Relic
$app->register(new \Ekino\Bundle\NewRelicBundle\Silex\EkinoNewRelicServiceProvider(), ['new_relic.application_name' => false, 'new_relic.log_exceptions' => true]);
// HTTP cache
if ($app['http_cache']) {
$app->register(new \Silex\Provider\HttpCacheServiceProvider(), ['http_cache.cache_dir' => __DIR__ . '/../../var/cache/', 'http_cache.options' => ['debug' => $app['debug']]]);
}
// Exception handler
$app->error(function (\Exception $e, $code) use($app) {
if ($app['debug']) {
return;
}
if ($e instanceof HttpException && $e->getStatusCode() == 429) {
// don't log rate limiting
} else {
$app['stats']->error($e);
}
$errors = [['message' => $e->getMessage()]];
$result = ['errors' => $errors];
return $app->json($result, $code);
});
// Monolog
$app->register(new \Silex\Provider\MonologServiceProvider(), ['monolog.logfile' => __DIR__ . '/../../var/logs/transport.log', 'monolog.level' => $app['monolog.level'], 'monolog.name' => 'transport']);
$app->before(function (Request $request) use($app) {
$app['monolog']->addInfo('- ' . $request->getClientIp() . ' ' . $request->headers->get('referer') . ' ' . $request->server->get('HTTP_USER_AGENT'));
});
// if hosted behind a reverse proxy
if ($app['proxy']) {
$proxies = [$_SERVER['REMOTE_ADDR']];
if (is_array($app['proxy'])) {
$proxies = $app['proxy'];
}
Request::setTrustedProxies($proxies);
}
// Initialize buzz client
$client = $app['buzz.client'] ?: new \Buzz\Client\FileGetContents();
if ($app['proxy_server.address']) {
$client->setProxy($app['proxy_server.address']);
}
// create Transport API
$app['api'] = new \Transport\API(new \Buzz\Browser($client));
// allow cross-domain requests, enable cache
$app->after(function (Request $request, Response $response) use($app) {
$response->headers->set('Access-Control-Allow-Origin', '*');
if ($app['http_cache']) {
$response->headers->set('Cache-Control', 's-maxage=30, public');
}
});
// Serializer
$app['serializer'] = $app->share(function () use($app) {
$fields = $app['request']->get('fields') ?: [];
return new Serializer([new FieldsNormalizer($fields)], ['json' => new JsonEncoder()]);
});
// Redis
$redis = null;
try {
if ($app['redis.config']) {
$redis = new \Predis\Client($app['redis.config']);
$redis->connect();
}
} catch (\Exception $e) {
$app['monolog']->addError($e->getMessage());
$redis = null;
}
// statistics
$app['stats'] = new \Transport\Statistics($redis, $app['stats.config']['enabled']);
$app->after(function (Request $request, Response $response) use($app) {
if ($response->getStatusCode() !== 429) {
$app['stats']->call();
$app['stats']->resource($request->getPathInfo());
}
});
// rate limiting
$app['rate_limiting'] = new \Transport\RateLimiting($redis, $app['rate_limiting.config']['enabled'], $app['rate_limiting.config']['limit']);
$app->before(function (Request $request) use($app) {
if ($app['rate_limiting']->isEnabled()) {
$ip = $request->getClientIp();
if ($app['rate_limiting']->hasReachedLimit($ip)) {
throw new HttpException(429, 'Rate limit of ' . $app['rate_limiting']->getLimit() . ' requests per second exceeded');
}
$app['rate_limiting']->increment($ip);
}
});
$app->after(function (Request $request, Response $response) use($app) {
if ($app['rate_limiting']->isEnabled()) {
$ip = $request->getClientIp();
$response->headers->set('X-Rate-Limit-Limit', $app['rate_limiting']->getLimit());
$response->headers->set('X-Rate-Limit-Remaining', $app['rate_limiting']->getRemaining($ip));
$response->headers->set('X-Rate-Limit-Reset', $app['rate_limiting']->getReset());
}
});
// home
$app->get('/', function () use($app) {
return file_get_contents('index.html');
})->bind('home');
// api
$app->get('/v1/', function () use($app) {
return $app->json(['date' => date('c'), 'author' => 'Opendata.ch', 'version' => '1.0']);
})->bind('api');
/**
* Search locations.
*
* Returns the matching locations for the given parameters. Either query or ( x and y ) are required.
*
* The locations in the response are scored to determine which is the most exact location.
*
* This method can return a refine response, what means that the request has to be redone.
*
* @SWG\Get(
* path="/locations",
* tags={"locations"},
* @SWG\Parameter(
* name="query",
* in="query",
* description="Specifies the location name to search for (e.g. Basel)",
* type="string"
* ),
* @SWG\Parameter(
* name="x",
* in="query",
* description="Latitude (e.g. 47.476001)",
* type="number"
* ),
* @SWG\Parameter(
* name="y",
* in="query",
* description="Longitude (e.g. 8.306130)",
* type="number"
* ),
* @SWG\Parameter(
* name="type",
* in="query",
* description="Only with `query` parameter. Specifies the location type, possible types are:<ul><li>`all` (default): Looks up for all types of locations</li><li>`station`: Looks up for stations (train station, bus station)</li><li>`poi`: Looks up for points of interest (Clock tower, China garden)</li><li>`address`: Looks up for an address (Zurich Bahnhofstrasse 33)</li></ul>",
* type="string"
* ),
* @SWG\Parameter(
* name="transportations[]",
* in="query",
* description="Only with `x` and `y` parameter. Transportation means; one or more of `ice_tgv_rj`, `ec_ic`, `ir`, `re_d`, `ship`, `s_sn_r`, `bus`, `cableway`, `arz_ext`, `tramway_underground` (e.g. transportations[]=ec_ic&transportations[]=bus)",
* type="string"
* ),
* @SWG\Response(
* response="200",
* description="List of locations",
* @SWG\Schema(
* type="object",
* @SWG\Property(
* property="stations",
* type="array",
* @SWG\Items(ref="#/definitions/Location")
* ),
* ),
* ),
* )
*/
$app->get('/v1/locations', function (Request $request) use($app) {
$stations = [];
$x = $request->get('x') ?: null;
$y = $request->get('y') ?: null;
$transportations = $request->get('transportations');
if ($x && $y) {
$query = new NearbyQuery($x, $y);
if ($transportations) {
$query->transportations = (array) $transportations;
}
$stations = $app['api']->findNearbyLocations($query);
}
$query = $request->get('query');
if ($query) {
$query = new LocationQuery($query, $request->get('type'));
$stations = $app['api']->findLocations($query);
}
$result = ['stations' => $stations];
$json = $app['serializer']->serialize((object) $result, 'json');
return new Response($json, 200, ['Content-Type' => 'application/json']);
})->bind('locations');
/**
* Search connections.
*
* Returns the next connections from a location to another.
*
* @SWG\Get(
* path="/connections",
* tags={"connections"},
* @SWG\Parameter(
* name="from",
* in="query",
* description="Specifies the departure location of the connection (e.g. Lausanne)",
* type="string",
* required=true
* ),
* @SWG\Parameter(
* name="to",
* in="query",
* description="Specifies the arrival location of the connection (e.g. Genève)",
* type="string",
* required=true
* ),
* @SWG\Parameter(
* name="via[]",
* in="query",
* description="Specifies up to five via locations. When specifying several vias, array notation (via[]=Bern&via[]=Fribourg) is required",
* type="string"
* ),
* @SWG\Parameter(
* name="date",
* in="query",
* description="Date of the connection, in the format YYYY-MM-DD (e.g. 2012-03-25)",
* type="string"
* ),
* @SWG\Parameter(
* name="time",
* in="query",
* description="Time of the connection, in the format hh:mm (e.g. 17:30)",
* type="string"
* ),
* @SWG\Parameter(
* name="isArrivalTime",
* in="query",
* description="defaults to `0`, if set to `1` the passed `date` and `time` is the arrival time",
* type="integer"
* ),
* @SWG\Parameter(
* name="transportations[]",
* in="query",
* description="Transportation means; one or more of `ice_tgv_rj`, `ec_ic`, `ir`, `re_d`, `ship`, `s_sn_r`, `bus`, `cableway`, `arz_ext`, `tramway_underground` (e.g. transportations[]=ec_ic&transportations[]=bus)",
* type="string"
* ),
* @SWG\Parameter(
* name="limit",
* in="query",
* description="1 - 6. Specifies the number of connections to return. If several connections depart at the same time they are counted as 1.",
* type="integer"
* ),
* @SWG\Parameter(
* name="page",
* in="query",
* description="0 - 10. Allows pagination of connections. Zero-based, so first page is 0, second is 1, third is 2 and so on.",
* type="integer"
* ),
* @SWG\Parameter(
* name="direct",
* in="query",
* description="defaults to `0`, if set to `1` only direct connections are allowed",
* type="integer"
* ),
* @SWG\Parameter(
* name="sleeper",
* in="query",
* description="defaults to `0`, if set to `1` only night trains containing beds are allowed, implies `direct=1`",
* type="integer"
* ),
* @SWG\Parameter(
* name="couchette",
* in="query",
* description="defaults to `0`, if set to `1` only night trains containing couchettes are allowed, implies `direct=1`",
* type="integer"
* ),
* @SWG\Parameter(
* name="bike",
* in="query",
* description="defaults to `0`, if set to `1` only trains allowing the transport of bicycles are allowed",
* type="integer"
* ),
* @SWG\Parameter(
* name="accessibility",
* in="query",
* description="Possible values are `independent_boarding`, `assisted_boarding`, and `advanced_notice`",
* type="string"
* ),
* @SWG\Response(
* response="200",
* description="A list of connections",
* @SWG\Schema(
* type="object",
* @SWG\Property(
* property="connections",
* type="array",
* description="Found connections",
* @SWG\Items(ref="#/definitions/Connection")
* ),
* @SWG\Property(
* property="from",
* description="Departure station of search",
* ref="#/definitions/Station"
* ),
* @SWG\Property(
* property="to",
* description="Arrival station of search",
* ref="#/definitions/Station"
* ),
* @SWG\Property(
* property="stations",
* type="array",
* description="All stations from query",
* @SWG\Items(ref="#/definitions/Station")
* ),
* ),
* ),
* )
*/
$app->get('/v1/connections', function (Request $request) use($app) {
$query = LocationQueryParser::create($request);
// get stations
$stations = $app['api']->findLocations($query);
// get connections
$connections = [];
$from = reset($stations['from']) ?: null;
$to = reset($stations['to']) ?: null;
$via = [];
foreach ($stations as $k => $v) {
if (preg_match('/^via[0-9]+$/', $k) && $v) {
$via[] = reset($v);
}
}
if ($from && $to) {
$app['stats']->station($from);
$app['stats']->station($to);
$query = ConnectionQueryParser::create($request, $from, $to, $via);
$errors = ConnectionQueryParser::validate($query);
if ($errors) {
return $app->json(['errors' => $errors], 400);
}
$connections = $app['api']->findConnections($query);
}
$result = ['connections' => $connections, 'from' => $from, 'to' => $to, 'stations' => $stations];
$json = $app['serializer']->serialize((object) $result, 'json');
return new Response($json, 200, ['Content-Type' => 'application/json']);
})->bind('connections');
/**
* Get station board.
*
* Returns the next connections leaving from a specific location.
*
* @SWG\Get(
* path="/stationboard",
* tags={"stationboard"},
* @SWG\Parameter(
* name="station",
* in="query",
* description="Specifies the location of which a stationboard should be returned (e.g. Aarau)",
* type="string",
* required=true
* ),
* @SWG\Parameter(
* name="id",
* in="query",
* description="The id of the station whose stationboard should be returned. Alternative to the station parameter; one of these two is required. If both an id and a station are specified the id has precedence. e.g. 8503059 (for Zurich Stadelhofen)",
* type="string"
* ),
* @SWG\Parameter(
* name="limit",
* in="query",
* description="Number of departing connections to return. This is not a hard limit - if multiple connections leave at the same time it'll return any connections that leave at the same time as the last connection within the limit. For example: `limit=4` will return connections leaving at: 19:30, 19:32, 19:32, 19:35, 19:35. Because one of the connections leaving at 19:35 is within the limit, all connections leaving at 19:35 are shown.",
* type="integer"
* ),
* @SWG\Parameter(
* name="transportations[]",
* in="query",
* description="Transportation means; one or more of `ice_tgv_rj`, `ec_ic`, `ir`, `re_d`, `ship`, `s_sn_r`, `bus`, `cableway`, `arz_ext`, `tramway_underground` (e.g. transportations[]=ec_ic&transportations[]=bus)",
* type="string"
* ),
* @SWG\Parameter(
* name="datetime",
* in="query",
* description="Date and time of departing connections, in the format `YYYY-MM-DD hh:mm` (e.g. 2012-03-25 17:30)",
* type="string"
* ),
* @SWG\Parameter(
* name="type",
* in="query",
* description="`departure` (default) or `arrival`",
* type="string"
* ),
* @SWG\Response(
* response="200",
* description="Stationboard",
* @SWG\Schema(
* type="object",
* @SWG\Property(
* property="station",
* description="The first matched location based on the query. The stationboard will be displayed if this is a station.",
* ref="#/definitions/Station"
* ),
* @SWG\Property(
* property="stationboard",
* description="A list of journeys with the stop of the line leaving from that station.",
* type="array",
* @SWG\Items(ref="#/definitions/Journey")
* ),
* ),
* ),
* )
*/
$app->get('/v1/stationboard', function (Request $request) use($app) {
$stationboard = [];
$limit = $request->get('limit', 40);
if ($limit > 420) {
return new Response('Invalid value for Parameter `limit`.', 400);
}
$date = $request->get('date');
if (!$date) {
$date = $request->get('datetime');
}
if ($date) {
$date = new \DateTime($date, new \DateTimeZone('Europe/Zurich'));
}
$transportations = $request->get('transportations');
$station = $request->get('station') ?: $request->get('id');
$boardType = $request->get('type');
$query = new LocationQuery($station, 'station');
$stations = $app['api']->findLocations($query);
$station = reset($stations);
if ($station instanceof Station) {
$app['stats']->station($station);
$query = new StationBoardQuery($station, $date);
if ($transportations) {
$query->transportations = (array) $transportations;
}
if ($boardType) {
$query->boardType = $boardType;
}
$query->maxJourneys = $limit;
$stationboard = $app['api']->getStationBoard($query);
}
$result = ['station' => $station, 'stationboard' => $stationboard];
$json = $app['serializer']->serialize((object) $result, 'json');
return new Response($json, 200, ['Content-Type' => 'application/json']);
})->bind('stationboard');
// Swagger
$app->get('/swagger.json', function () use($app) {
$swagger = \Swagger\scan(__DIR__);
return new Response($swagger, 200, ['Content-Type' => 'application/json']);
})->bind('swagger');
}
});
Route::get(Config::get('swaggervel.api-docs-route'), function () {
if (Config::get('swaggervel.generateAlways')) {
$appDir = base_path() . '/' . Config::get('swaggervel.app-dir');
$docDir = Config::get('swaggervel.doc-dir');
if (!File::exists($docDir) || is_writable($docDir)) {
// delete all existing documentation
if (File::exists($docDir)) {
File::deleteDirectory($docDir);
}
File::makeDirectory($docDir);
$defaultBasePath = Config::get('swaggervel.default-base-path');
$defaultApiVersion = Config::get('swaggervel.default-api-version');
$defaultSwaggerVersion = Config::get('swaggervel.default-swagger-version');
$excludeDirs = Config::get('swaggervel.excludes');
$swagger = \Swagger\scan($appDir, ['exclude' => $excludeDirs]);
$filename = $docDir . '/api-docs.json';
file_put_contents($filename, $swagger);
}
}
if (Config::get('swaggervel.behind-reverse-proxy')) {
$proxy = Request::server('REMOTE_ADDR');
Request::setTrustedProxies(array($proxy));
}
Blade::setEscapedContentTags('{{{', '}}}');
Blade::setContentTags('{{', '}}');
//need the / at the end to avoid CORS errors on Homestead systems.
$response = response()->view('swaggervel::index', array('secure' => Request::secure(), 'urlToDocs' => url(Config::get('swaggervel.doc-route')), 'requestHeaders' => Config::get('swaggervel.requestHeaders'), 'clientId' => Request::input('client_id'), 'clientSecret' => Request::input('client_secret'), 'realm' => Request::input('realm'), 'appName' => Request::input('appName')));
//need the / at the end to avoid CORS errors on Homestead systems.
/*$response = Response::make(
View::make('swaggervel::index', array(
<?php
require "vendor/autoload.php";
$swagger = \Swagger\scan('app');
header('Content-Type: application/json');
echo $swagger;
/**
* @return \Ovr\Swagger\SwaggerWrapper
*/
protected function getSwaggerWrapper()
{
return new \Ovr\Swagger\SwaggerWrapper(\Swagger\scan(__DIR__ . '/../../examples'));
}
<?php
include_once __DIR__ . '/vendor/autoload.php';
/** @var \Swagger\Annotations\Swagger $swagger */
$swagger = \Swagger\scan([__DIR__ . '/examples/api/controller', __DIR__ . '/examples/api/model']);
$wrapper = new \Ovr\Swagger\SwaggerWrapper($swagger);
$operation = $wrapper->getOperationByName('getUserById');
//dump($operation);
$response = new \Symfony\Component\HttpFoundation\JsonResponse();
$response->setData(['data' => (object) ['id' => 1, 'name' => 'Test']]);
$wrapper->assertHttpResponseForOperation($response, $operation);
/**
* Get swagger object
*
* @return \Swagger\Swagger
*/
protected function getSwagger()
{
return \Swagger\scan($this->scanDir, $this->scanOptions);
}
public function testAugmentParameter()
{
$swagger = \Swagger\scan(__DIR__ . '/Fixtures/UsingRefs.php');
$this->assertCount(1, $swagger->parameters, 'Swagger contains 1 reusable parameter specification');
$this->assertEquals('ItemName', $swagger->parameters[0]->parameter, 'When no @SWG\\Parameter()->parameter is specified, use @SWG\\Parameter()->name');
}
<?php
include '../../common/session.php';
include SITE_ROOT . '/classes/Swagger/functions.php';
$swagger = \Swagger\scan(SITE_ROOT . '/api/v1');
header("Access-Control-Allow-Origin: *");
header("Access-Control-Allow-Methods: *");
header('Content-Type: application/json');
echo $swagger;
function testExclude()
{
$swagger = \Swagger\scan(__DIR__ . '/Fixtures', ['exclude' => ['Customer.php', 'UsingRefs.php', 'GrandParent.php']]);
$this->assertSame('Fixture for ParserTest', $swagger->info->title, 'No errors about duplicate @SWG\\Info() annotations');
}
* title="STUN TURN REST API",
* description="NIIF Intitute STUN TURN REST API pilot",
* @SWG\Contact(name="Mihály MÉSZÁROS", url="https://brain.lab.vvc.niif.hu"),
* ),
* @SWG\Tag(
* name="rest api",
* description="STUN/TURN time limited long term credential mechanism"
* )
* )
*/
require_once "../vendor/autoload.php";
require_once "../../Db.php";
require_once "lib/Coturn.php";
require_once "lib/ApiResponse.php";
$app = new \Slim\Slim();
$app->setName('TURN REST API');
$app->container->singleton('token', function () {
return "xyz";
/// token
});
$app->get('/', function () use($app) {
$app->redirect('doc/index.html');
});
$app->get('/swagger.json', function () {
$swagger = \Swagger\scan('.');
header('Content-Type: application/json');
echo $swagger;
});
$app->get('/stun', '\\Coturn:Get');
$app->get('/turn', '\\Coturn:Get');
$app->run();
<?php
chdir(dirname(__DIR__));
require 'vendor/autoload.php';
$swagger = \Swagger\scan('src/');
header('Content-Type: application/json');
echo $swagger;
/**
* Will give swagger.json
* @return string
*/
private function renderDocumentation()
{
$swagger = (string) \Swagger\scan($this->dirToScan);
$swagger = (array) json_decode($swagger);
if ($this->apc) {
$swagger = $this->addCacheFlushEndpoint($swagger);
}
$json = json_encode($swagger);
return $json;
}
<?php
require_once __DIR__ . '/../../vendor/autoload.php';
$swagger = \Swagger\scan(realpath(__DIR__ . '/..'));
header('Access-Control-Allow-Origin: *');
header('Access-Control-Allow-Headers: Origin, X-Atmosphere-tracking-id, X-Atmosphere-Framework, X-Cache-Date, Content-Type, X-Atmosphere-Transport, *');
header('Access-Control-Allow-Methods: POST, GET, OPTIONS , PUT');
header('Access-Control-Request-Headers: Origin, X-At2mosphere-tracking-id, X-Atmosphere-Framework, X-Cache-Date, Content-Type, X-Atmosphere-Transport, *');
header('Content-Type: application/json');
echo $swagger;
/**
* @return \Swagger\Annotations\Swagger
*/
public function getSwagger()
{
$swagger = \Swagger\scan($this->config->getBasePath(), $this->config->getScanOptions());
return $swagger;
}
/**
* Test the processed Examples against json files in ExamplesOutput.
*
* @dataProvider getExamples
* @param string $example Example path
* @param string $output Expected output (path to a json file)
*/
public function testExample($example, $output)
{
$swagger = \Swagger\scan(__DIR__ . '/../Examples/' . $example);
// die((string) $swagger);
$this->assertSwaggerEqualsFile(__DIR__ . '/ExamplesOutput/' . $output, $swagger);
}
<?php
require __DIR__ . '/../vendor/autoload.php';
$swagger = \Swagger\scan(__DIR__ . '/../app');
header('Content-Type: application/json');
echo $swagger;
<?php
require "SwaggerDoc/autoload.php";
$swagger = \Swagger\scan('./PetStore');
header('Content-Type: application/json');
echo $swagger;
