API-Guide.md

October 17, 2024 ยท View on GitHub

Table of Contents

Concepts

The following libraries are used to implement API in Orochi:

  • Django-ninja: a powerful and flexible toolkit for building Web APIs.

Login

To have full access to API, first need login. The GUI is available on port 8000, so if you are running dockers locally: http://127.0.0.1:8000

sign-in

Swagger

Swagger is a set of open-source tools built around the OpenAPI Specification that can help you design, build, document and consume REST APIs. Swagger is available at https://localhost/api/docs

api-swagger

Demo notebook

A python example on API usage is available here