Raml\Parser::parseFromString PHP Method

parseFromString() public method

Parse a RAML spec from a string
public parseFromString ( string $ramlString, string $rootDir ) : ApiDefinition
$ramlString string
$rootDir string
return ApiDefinition
    public function parseFromString($ramlString, $rootDir)
    {
        $ramlData = $this->parseRamlString($ramlString, $rootDir);
        return $this->parseRamlData($ramlData, $rootDir);
    }

Usage Example

    /**
     * Returns a valid api def
     *
     * @throws \Exception
     *
     * @return \Raml\ApiDefinition
     */
    private function getValidDef()
    {
        $raml = <<<RAML
#%RAML 0.8
title: Users API
version: 1.2
baseUri: https://{apiDomain}.someapi.com/{version}
/users:
  displayName: retrieve all users
  baseUriParameters:
    apiDomain:
      enum: [ "api" ]
  /{userId}/image:
    displayName: access users pictures
    baseUriParameters:
      apiDomain:
        enum: [ "static" ]
    get:
      displayName: retrieve a user's picture
    put:
      displayName: update a user's picture
      baseUriParameters:
        apiDomain:
          enum: [ "content-update" ]
RAML;
        return $this->parser->parseFromString($raml, '');
    }
All Usage Examples Of Raml\Parser::parseFromString