Leveraging the OpenAPI definitions to gracefully generate a client on a regular cadence - also generates typescript types for the API
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
There are currently a few different SDKs for interacting with the Hetzner API, but none of them were staying up to date using the current OpenAPI definition published on the Hetzner website. This project aims to solve that by using the OpenAPI definition to generate a client on a regular cadence.
To get setup we just need to install the library locally and then we can start defining our states and transitions.
npm install hetzner-sdk-tsI'd like to exhaustively output types and API definitions here or in an accompanying document. The easiest way to look at the API is just to read the documentation and use the corresponding methods that are generated or you can look through the generated output.
import { OpenAPI, ServersService } from "hetzner-sdk-ts";
// Set the API key - this will apply globally to all requests
OpenAPI.TOKEN = apiKey;
// Get a list of all servers
const { servers } = await ServersService.getServers({});Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
DJ Petersen - @thedjpetersen
Project Link: https://github.com/thedjpetersen/hetzner-sdk-ts