VitePress OpenAPI

Appearance

ID: getAllArtists

Get all artists​

Artists
GET
/api/v1/artists
Server

Get a list of all legendary Argentine Rock artists and explore their contributions to the music scene.

Parameters​

Query Parameters

limit

The number of items to return

Typeinteger
Examples
102050
formatint64
default10
offset

The number of items to skip before starting to collect the result set

Typeinteger
Examples
123456
formatint64
default0

Responses​

OK
application/json
JSON
{
"data": [
{
"id": 1,
"name": "Charly García",
"description": "One of the most influential rock musicians in Argentine history.",
"image": "https://cdn.rock-legends.com/photos/charly.jpg",
"band": "Sui Generis"
}
],
"meta": {
"limit": 10,
"offset": 0,
"total": 100,
"next": "/artists?limit=10&offset=10"
}
}

Samples​

Bruno
get {
  url: https://localhost:3000/api/v1/artists?limit=10&offset=1
}

headers {
  Content-Type: application/json
}
Bruno
get {
  url: https://localhost:3000/api/v1/artists?limit=10&offset=1
}

headers {
  Content-Type: application/json
}
cURL
curl -X GET \
'https://localhost:3000/api/v1/artists?limit=10&offset=1' \
 -H "Content-Type: application/json"
JavaScript
fetch('https://localhost:3000/api/v1/artists?limit=10&offset=1', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));
PHP
<?php
$url = 'https://localhost:3000/api/v1/artists';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];
$query = http_build_query([
    'limit' => '10',
    'offset' => '1',
]);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . '?' . $query);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
Python
import requests

url = 'https://localhost:3000/api/v1/artists'
params = {
    'limit': 10,
    'offset': 1
}
headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params, headers=headers)
print(response.json())
Powered by VitePress OpenAPI