Code

These are the endpoints used to retrieve system code: packages, classes and methods.

It is important to mention that the JSON objects returned by these endpoints should include common properties of every object. This is used by Webside IDE to provide inspection services over objects of the meta-model (classes, methods, etc.). These are the common properties at the moment:

{
  "class": "string",
  "hasNamedSlots": "boolean",
  "hasIndexedSlots": "boolean",
  "size": "number",
  "printString": "string"
}

Endpoints

Method	Path	Description	Parameters	Payload
GET	/methods	Retrieve methods satisfying the condition specified in the query (or all the methods in the system if no condition is provided)	selector, category, accessing, using, assigning, sending, referencingClass, selectorMatching, ast, annotations, bytecodes, dissasembly, count, modified	-
GET	/classes	Retrieve all subclasses of a given root class (if no root is provided, the uppermost class in the system is used). It is also possible get a tree-like structure as well as to limit the depth in the classes hierarchy	root, names, tree, depth, category	-
GET	/classes/{name}	Retrieve a given class	-	-
GET	/classes/{name}/superclasses	Retrieve superclasses a given class	-	-
GET	/classes/{name}/subclasses	Retrieve subclasses a given class	-	-
GET	/classes/{name}/variables	Retrieve instance and class variables of a given class	-	-
GET	/classes/{name}/instance-variables	Retrieve instance variables of a given class	-	-
GET	/classes/{name}/class-variables	Retrieve class variables of a given class	-	-
GET	/classes/{name}/categories	Retrieve categories of a given class	-	-
GET	/classes/{name}/used-categories	Retrieve categories used throughout the hierarchy of a given class	-	-
GET	/classes/{name}/methods	Retrieve methods of a given class	-	-
GET	/classes/{name}/selectors	Retrieve selectors of a given class	-	-
GET	/classes/{name}/methods/{selector}	Retrieve the method with the given selector in the given class	-	-
GET	/categories	Retrieve all categories in the system	-	-
GET	/usual-categories	Retrieve popular categories used throughout the system	-	-
GET	/packages	Retrieve all packages	names	-
GET	/packages/{name}	Retrieve a given package	-	-
GET	/packages/{name}/classes	Retrieve actual classes of a given package	extended, tree, names, category	-
GET	/packages/{name}/methods	Retrieve actual methods of a given package	-	-
GET	/search	Perform a search on the system	text, ignoreCase, condition, type	-
GET	/autocompletions	Retrieve completion entries for a given code, position and context	-	-
GET	/classtemplate	Provide a class template	package	-
GET	/methodtemplate	Provide a method template	-	-
POST	/selector	Find a selector in a piece of source code	-	-