Have questions? Stuck? Please check our FAQ for some common questions and answers.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

The purpose of this document will be to provide an overview and introduction to the ONOS APIs so that developers will know where to start.

  • The ONOS Java APIs are documented as standard javadoc documentation, and is available at api.onosproject.org .
    This documentation is a reference that describes each class and method at call-level detail, and is valuable when you are trying to understand existing code or write new code using a set of classes and objects that you are already familiar with.
     
  • The Architecture and Internals Guide provides an overview of the internal organization and implementation of the ONOS system. It describes several important subsystems and APIs at a higher level than the javadoc  documentation, so it is valuable when you are trying to understand which subsystems or classes are used by core modules and applications for particular kinds of tasks or problems.
  • No labels