Custom endpoint

Yul · 20 January 2025 17:24

Hi !

Could you please point me to the doc that details how to have a custom endpoint ?

Using my studio addon, my tests work all right, and the following url returns the correct data.
But I don’t find a way to get rid of the addon version (0.1.2 here) in the url.
(we don’t want to change the calls everytime the addon version changes)
http://myserverayon:5000/api/addons/myaddon/0.1.2/get-test-data/myProjectName

.

I have used the method found in those examples :

gist.github.com

https://gist.github.com/MustafaJafar/d89a350abd3c564237998ec143acc624

init.py

from typing import Type
from ayon_server.api.dependencies import CurrentUser
from ayon_server.addons import BaseServerAddon
from ayon_server.settings import BaseSettingsModel

# I've installed `art` module locally to my addon server code to a relative direcory called Lib
# pip install art --target=E:\Ynput\addons-test\my_addon\server\Libs
# Then, I've just created a package regulary and it included the Libs directory.
from .Libs.art import art

This file has been truncated. show original

martin.wacker · 21 January 2025 12:24

Paths to addon endpoints always contain the addon name and version, since all endpoints from all versions are always exposed. In the future, we might add placeholders that you could use (for example /api/addons/my_addon/production/my_endpoint but we’re not there yet. If you need to add a top level endpoint, you may try a different approach (addon-less).

Check, how API routes are constructed in ayon-backend/api - each directory contains one or more endpoints and in the __init__.py exports “router” object. If you implement your endpoints that way, you can then either build your own Ayon image or mount this directory as a volume to your existing container:

volumes:
  - /path/to/my/router:/backend/api/my_router

Yul · 21 January 2025 15:27

Thanks Martin.

Here is why I’m asking :

If we code a custom endpoint, to be used by other departments, we can’t tell them it’s a moving target, they need a fixed url, as in usual REST APIs.
Because other departments can’t use self.version or similar, as the calls are done from other softwares.

The future “production” placeholder solution that you described, would be perfect !

Thanks !

Yul · 21 January 2025 15:39

Do I need to create a feature request on the ayon-backend repo ?

Yul · 22 January 2025 09:15

I have created a feature request :

github.com/ynput/ayon-backend

custom endpoint url : allow production placeholder instead of version

opened 09:12AM - 22 Jan 25 UTC

alainxi

### Current situation : Currently, paths to addon endpoints always contain the …addon version, since all endpoints from all versions are always exposed. Example : http:// myserverayon:5000/api/addons/my_addon/**0.1.2**/get-test-data/myProjectName ### Problem : If we code a custom endpoint, to be used by other departments, we can’t tell them it’s a moving target, they need a fixed url, as in usual REST APIs. Because other departments can’t use self.version or similar, as the calls are done from other softwares. ### Proposal Please provide a “production" placeholder, that would replace the version. Example : /api/addons/my_addon/**production**/my_endpoint ### Context : It was discussed here : https://community.ynput.io/t/custom-endpoint/2149