websIDE
  • webside
    • Overview
  • API
    • General
      • Dialect
      • Version
      • Colors
      • Logo
      • Stats
      • Themes
      • Icons
      • Save Image
    • Changes
      • Retrieve changes
      • Apply a change
    • Changesets
      • Convert chunks to JSON changes
      • Convert JSON changes to chunks
    • Code
      • Autocompletions
        • Retrieve autocompletions
      • Categories
        • Retrieve categories
        • Retrieve usual categories
      • Classes
        • Retrieve classes
        • Retrieve a class
        • Retrieve categories
        • Retrieve variables
        • Retrieve class variables
        • Retrieve instance variables
        • Retrieve selectors
        • Retrieve methods
        • Retrieve method
        • Retrieve method history
        • Retrieve subclasses
        • Retrieve superclasses
        • Retrieve used categories
      • Methods
        • Retrieve methods
      • Packages
        • Retrieve packages
        • Retrieve a package
        • Retrieve package classes
        • Retrieve package methods
      • Search
      • Selectors
        • Find selector in source code
      • Templates
        • Retrieve class template
        • Retrieve method template
    • Debuggers
      • Retrieve active debuggers
      • Create a debugger
      • Delete debugger
      • Retrieve debugger frames
      • Retrieve debugger frame
      • Retrieve frame bindings
      • Restart debugger
      • Resume debugger
      • Step into debugger
      • Step over debugger
      • Step through debugger
      • Terminate debugger
    • Evaluations
      • Retrieve evaluations
      • Evaluate an expression
      • Cancel evaluation
      • Retrieve evaluation
      • Pause evaluation
      • Resume evaluation
    • Extensions
      • Retrieve extensions
      • Changes extensions
      • Export extensions
      • Search extensions
    • Commands
      • Retrieve command definitions
      • Invoke commands
    • Objects
      • Retrieve pinned objects
      • Pin object
      • Retrieve pinned object
      • Retrieve pinned object slots
        • Custom views
      • Unpin an object
      • Unpin all objects
    • Processes
      • Retrieve active processes
    • Profilers
      • Retrieve active profilers
      • Create a new profiler
      • Delete a profiler
      • Retrieve a profiler
      • Retrieve profiler ranking results
      • Retrieve profiler tree results
    • Testing
      • Run tests
      • Retrieve test run status
      • Retrieve test run results
    • Workspaces
      • Retrieve active workspaces
      • Create a new workspace
      • Delete a workspace
      • Retrieve a workspace
      • Update a workspace
      • Retrieve workspace bindings
Powered by GitBook
On this page
  1. API

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

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

-

GET

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

Retrieve a given class

-

-

GET

Retrieve superclasses a given class

-

-

GET

Retrieve subclasses a given class

-

-

GET

Retrieve instance and class variables of a given class

-

-

GET

Retrieve instance variables of a given class

-

-

GET

Retrieve class variables of a given class

-

-

GET

Retrieve categories of a given class

-

-

GET

Retrieve categories used throughout the hierarchy of a given class

-

-

GET

Retrieve methods of a given class

-

-

GET

Retrieve selectors of a given class

-

-

GET

Retrieve the method with the given selector in the given class

-

-

GET

Retrieve all categories in the system

-

-

GET

Retrieve popular categories used throughout the system

-

-

GET

Retrieve all packages

names

-

GET

Retrieve a given package

-

-

GET

Retrieve actual classes of a given package

extended, tree, names, category

-

GET

Retrieve actual methods of a given package

-

-

GET

Perform a search on the system

text, ignoreCase, condition, type

-

GET

Retrieve completion entries for a given code, position and context

-

-

GET

Provide a class template

package

-

GET

Provide a method template

-

-

POST

Find a selector in a piece of source code

-

-

PreviousConvert JSON changes to chunksNextAutocompletions

Last updated 11 months ago

/methods
/classes
/classes/{name}
/classes/{name}/superclasses
/classes/{name}/subclasses
/classes/{name}/variables
/classes/{name}/instance-variables
/classes/{name}/class-variables
/classes/{name}/categories
/classes/{name}/used-categories
/classes/{name}/methods
/classes/{name}/selectors
/classes/{name}/methods/{selector}
/categories
/usual-categories
/packages
/packages/{name}
/packages/{name}/classes
/packages/{name}/methods
/search
/autocompletions
/classtemplate
/methodtemplate
/selectors