Getting started

Using the omni.services extensions and Omniverse Kit’s –exec command-line option makes it easy to get started with services. As the service evolves and grows it might be worth turning the service itself into an Extension so that it is easy to ship and distribute. Doing so will also give all the power of extensions to services with the possibilities to set up dependencies on other extensions, install additional python packages and take advantage of the settings framework.

Basic service

Starting with a very simple hello world example:

from omni.services.core import main

def hello_world():
  return "hello world"

main.register_endpoint("get", "/hello-world", hello_world)

That is all there is needed to write a service. To run this with Omniverse Kit and an HTTP transport:

kit --exec hello_world.py --enable omni.services.core --enable omni.services.transport.server.http

By default an API doc page is spun up at:

http://localhost:8011/docs

It is possible to exercise the API from that webpage. By using the Try it out feature within the different endpoints.

Advanced services

A more involved example is available at the following GitHub Repository: https://github.com/NVIDIA-Omniverse/deep-dive-into-microservices

Omniverse Kit ships with several more advanced services and more are available in the extension registry and Omniverse Farm is also fully built using the microservices stack within Omniverse and is made up several different services. Its code is available from the Omniverse Launcher after which its code can be explored.