cdnJs

Libraries

libraries

Without any query parameters it will return the name and main file URL of every library on cdnjs. To search, use: Search query


/libraries

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/cdnjs/libraries?search=&output=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibrariesApi;

import java.io.File;
import java.util.*;

public class LibrariesApiExample {

    public static void main(String[] args) {
        
        LibrariesApi apiInstance = new LibrariesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String search = search_example; // String | 
        String output = output_example; // String | API will return minified result by default, if you wanna have a human readable result, try output=human
        String fields = fields_example; // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 
        try {
            inline_response_200 result = apiInstance.libraries(apiecoKey, search, output, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibrariesApi#libraries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibrariesApi;

public class LibrariesApiExample {

    public static void main(String[] args) {
        LibrariesApi apiInstance = new LibrariesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String search = search_example; // String | 
        String output = output_example; // String | API will return minified result by default, if you wanna have a human readable result, try output=human
        String fields = fields_example; // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 
        try {
            inline_response_200 result = apiInstance.libraries(apiecoKey, search, output, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibrariesApi#libraries");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *search = search_example; //  (optional)
String *output = output_example; // API will return minified result by default, if you wanna have a human readable result, try output=human (optional) (default to human)
String *fields = fields_example; // If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                  (optional)

LibrariesApi *apiInstance = [[LibrariesApi alloc] init];

[apiInstance librariesWith:apiecoKey
    search:search
    output:output
    fields:fields
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdnJs = require('cdn_js');

var api = new CdnJs.LibrariesApi()

var apiecoKey = apiecoKey_example; // {String} 

var opts = { 
  'search': search_example, // {String} 
  'output': output_example, // {String} API will return minified result by default, if you wanna have a human readable result, try output=human
  'fields': fields_example // {String} If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.libraries(apiecoKey, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class librariesExample
    {
        public void main()
        {
            
            var apiInstance = new LibrariesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var search = search_example;  // String |  (optional) 
            var output = output_example;  // String | API will return minified result by default, if you wanna have a human readable result, try output=human (optional)  (default to human)
            var fields = fields_example;  // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                  (optional) 

            try
            {
                inline_response_200 result = apiInstance.libraries(apiecoKey, search, output, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibrariesApi.libraries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LibrariesApi();
$apiecoKey = apiecoKey_example; // String | 
$search = search_example; // String | 
$output = output_example; // String | API will return minified result by default, if you wanna have a human readable result, try output=human
$fields = fields_example; // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 

try {
    $result = $api_instance->libraries($apiecoKey, $search, $output, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LibrariesApi->libraries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibrariesApi;

my $api_instance = WWW::SwaggerClient::LibrariesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $search = search_example; # String | 
my $output = output_example; # String | API will return minified result by default, if you wanna have a human readable result, try output=human
my $fields = fields_example; # String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 

eval { 
    my $result = $api_instance->libraries(apiecoKey => $apiecoKey, search => $search, output => $output, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LibrariesApi->libraries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibrariesApi()
apiecoKey = apiecoKey_example # String | 
search = search_example # String |  (optional)
output = output_example # String | API will return minified result by default, if you wanna have a human readable result, try output=human (optional) (default to human)
fields = fields_example # String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                  (optional)

try: 
    api_response = api_instance.libraries(apiecoKey, search=search, output=output, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LibrariesApi->libraries: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
search
output
String
API will return minified result by default, if you wanna have a human readable result, try output=human
fields
String
If you would like more data, use the fields parameter which takes comma-separated values. To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets Other fields available are: version description homepage keywords license repository autoupdate author assets

Responses

Status: 200 - Successful


librariesByName

You can also "select" a certain library if you already know its name on cdnjs, e.g.


/libraries/{name}

Usage and SDK Samples

curl -X GET "https://api.apieco.ir/cdnjs/libraries/{name}?output=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibrariesApi;

import java.io.File;
import java.util.*;

public class LibrariesApiExample {

    public static void main(String[] args) {
        
        LibrariesApi apiInstance = new LibrariesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String name = name_example; // String | 
        String output = output_example; // String | API will return minified result by default, if you wanna have a human readable result, try output=human
        String fields = fields_example; // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 
        try {
            inline_response_200 result = apiInstance.librariesByName(apiecoKey, name, output, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibrariesApi#librariesByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibrariesApi;

public class LibrariesApiExample {

    public static void main(String[] args) {
        LibrariesApi apiInstance = new LibrariesApi();
        String apiecoKey = apiecoKey_example; // String | 
        String name = name_example; // String | 
        String output = output_example; // String | API will return minified result by default, if you wanna have a human readable result, try output=human
        String fields = fields_example; // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 
        try {
            inline_response_200 result = apiInstance.librariesByName(apiecoKey, name, output, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibrariesApi#librariesByName");
            e.printStackTrace();
        }
    }
}
String *apiecoKey = apiecoKey_example; // 
String *name = name_example; // 
String *output = output_example; // API will return minified result by default, if you wanna have a human readable result, try output=human (optional) (default to human)
String *fields = fields_example; // If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                  (optional)

LibrariesApi *apiInstance = [[LibrariesApi alloc] init];

[apiInstance librariesByNameWith:apiecoKey
    name:name
    output:output
    fields:fields
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var CdnJs = require('cdn_js');

var api = new CdnJs.LibrariesApi()

var apiecoKey = apiecoKey_example; // {String} 

var name = name_example; // {String} 

var opts = { 
  'output': output_example, // {String} API will return minified result by default, if you wanna have a human readable result, try output=human
  'fields': fields_example // {String} If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.librariesByName(apiecoKey, name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class librariesByNameExample
    {
        public void main()
        {
            
            var apiInstance = new LibrariesApi();
            var apiecoKey = apiecoKey_example;  // String | 
            var name = name_example;  // String | 
            var output = output_example;  // String | API will return minified result by default, if you wanna have a human readable result, try output=human (optional)  (default to human)
            var fields = fields_example;  // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                  (optional) 

            try
            {
                inline_response_200 result = apiInstance.librariesByName(apiecoKey, name, output, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibrariesApi.librariesByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\LibrariesApi();
$apiecoKey = apiecoKey_example; // String | 
$name = name_example; // String | 
$output = output_example; // String | API will return minified result by default, if you wanna have a human readable result, try output=human
$fields = fields_example; // String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 

try {
    $result = $api_instance->librariesByName($apiecoKey, $name, $output, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LibrariesApi->librariesByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibrariesApi;

my $api_instance = WWW::SwaggerClient::LibrariesApi->new();
my $apiecoKey = apiecoKey_example; # String | 
my $name = name_example; # String | 
my $output = output_example; # String | API will return minified result by default, if you wanna have a human readable result, try output=human
my $fields = fields_example; # String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                 

eval { 
    my $result = $api_instance->librariesByName(apiecoKey => $apiecoKey, name => $name, output => $output, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LibrariesApi->librariesByName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibrariesApi()
apiecoKey = apiecoKey_example # String | 
name = name_example # String | 
output = output_example # String | API will return minified result by default, if you wanna have a human readable result, try output=human (optional) (default to human)
fields = fields_example # String | If you would like more data, use the fields parameter which takes comma-separated values.
To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets

Other fields available are:
version
description
homepage
keywords
license
repository
autoupdate
author
assets                  (optional)

try: 
    api_response = api_instance.libraries_by_name(apiecoKey, name, output=output, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LibrariesApi->librariesByName: %s\n" % e)

Parameters

Path parameters
Name Description
name*
String
Required
Header parameters
Name Description
apieco-key*
String
Required
Query parameters
Name Description
output
String
API will return minified result by default, if you wanna have a human readable result, try output=human
fields
String
If you would like more data, use the fields parameter which takes comma-separated values. To get a list of all files for that library, use the assets field. /libraries/:library?fields=assets Other fields available are: version description homepage keywords license repository autoupdate author assets

Responses

Status: 200 - Successful