Skip to content

kaleho/upcloud-api-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

cf41e94 · May 7, 2019

History

72 Commits
Sep 28, 2017
Sep 8, 2017
Oct 30, 2017
Aug 15, 2017
Oct 30, 2017
Sep 4, 2017
Aug 15, 2017
Dec 14, 2017
Aug 22, 2017
Oct 23, 2017
Sep 8, 2017
Sep 28, 2017
Sep 28, 2017
Oct 30, 2017
Sep 8, 2017
May 7, 2019
Aug 14, 2017

Repository files navigation

UpCloud API Specification

This OpenAPI Specification allows anyone to build new API clients against the UpCloud API using Swagger.

Table of content

Dependencies

You can use either one of these two dependency management tools, Yarn or npm, to install all necessary packages.

Yarn

To install Yarn itself, follow the instructions applicable to your operating system.

Then run the command below to download and install the required dependencies.

$ yarn

npm

npm is distributed together with Node.js which you can download from their web site.

With npm ready to go, use the following command to resolve the dependencies.

$ npm install

Installation

Init swagger codegen after cloning the project with the following commands.

$ git submodule init
$ git submodule update
$ cd swagger-codegen
$ mvn clean package

Usage

Ideally the base URL for all API operations should be https://api.upcloud.com/ and require basic authentication using UpCloud username and password. We recommend creating a subaccount dedicated for the API communication for security purposes. This allows you to restrict API access by servers, storages, and tags ensuring you will never accidentally affect critical systems.

Development

$ yarn dev

or

$ npm run dev

Production

$ yarn start

or

$ npm start

Documentation

Swagger provides documentation on the OpenAPI Specification.

Issues

Found a bug, have a problem using the client, or anything else about the library you would want to mention? Open a new issue here to get in contact.

License

This project is distributed under the MIT License, see LICENSE.txt for more information.

About

UpCloud API Swagger specification

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published