Rest api

REST API

Ścieżki podane poniżej są bez prefiksu - np. /backend.

TIP (wysyłanie żądania pod podany adres z daną metodą): curl -X POST http://asvis.local.pl/backend -b numbers=[1,3,5]

Do przemyślenia - synchronizacja baz.

Node'y

GET /nodes/find/[number]

Wyszukuje node'y po numerze, zwraca w kolejności alfabetycznej.

• params:

  • number [int] - wyszukuje na zasadzie ilike value%

• example: GET /node/find/345 - wyszukuje wszystkie numery wierzchołków rozpoczynające się od "345"

  • response:

{
"34567": {"name":"AS34567"}
"34579": {"name":"AS34579"}
"345": {"name":"AS345"}
}

POST /nodes/meta

• params:

  • numbers [str] - przykład: "[1234,2345,52345,234523]"

• example: POST /nodes/meta

  • response:

{
"1234": {"name":"AS1234", "pools":[{"netmask":24, ...}, ...]},
"4234": {"name":"AS4234", "pools":[{"netmask":12, ...}, ...]},
}

Struktury

GET /structure/graph/[node_number]/[depth]

Kolejność od node'ów o większej ilości (całkowitej) połączeń, do tych z mniejszą.

• params:

  • node_number [int]
  • dept [int]

• example: POST /structure/graph/345/10 - pobierz strukturę grafu od wierzchołka 345 do 10 połączeń wgłąb

  • response:

{
"345": {"connections_up":[3245,2345,2356], "connections_down":[34765,1235,5325]},
"4234": {"connections_up":[3245,2345,2356], "connections_down":[]}
}

GET /structure/tree/[node_number]/[height]

• params:

  • node_number [int]
  • height [int]

• example: POST /structure/tree/345/10 - pobierz strukturę drzewiastą o korzeniu w nodzie o 345 i wysokości 10

  • response:

{
"345": {"connections_up":[3245,2345,2356], "connections_down":[3545,1235,5325]},
"4234": {"connections_up":[3245,2345,2356], "connections_down":[]}
}