https://github.com/krystal/go-katapult
Go client library for Katapult
https://github.com/krystal/go-katapult
api-client api-client-go client go golang infrastructure katapult
Last synced: 12 months ago
JSON representation
Go client library for Katapult
- Host: GitHub
- URL: https://github.com/krystal/go-katapult
- Owner: krystal
- License: mit
- Created: 2020-10-07T18:44:14.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-05T14:59:44.000Z (over 1 year ago)
- Last Synced: 2025-04-05T13:02:46.417Z (about 1 year ago)
- Topics: api-client, api-client-go, client, go, golang, infrastructure, katapult
- Language: Go
- Homepage: https://pkg.go.dev/github.com/krystal/go-katapult
- Size: 1.56 MB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
go-katapult
Go client library for Katapult.
---
**WARNING:** Work in progress; features are missing, there will be breaking
changes.
---
Documentation:
- [API Documentation](https://developers.katapult.io/api/docs/latest/)
- [Katapult Documentation](https://docs.katapult.io/)
# Experimental "next" Client
A more feature complete client is being generated in the `next` package.
The aim for this client is to be generated from an openapi spec and should
offer access to everything that is documented / exposed in our API documentation.
## Usage Guidance
Each endpoint has multiple functions for calling it.
Typically `FunctionName` and `FunctionNameWithResponse` are provided.
It is recommended to use the `FunctionNameWithResponse` functions as they
return a response object that contains the response data and the HTTP response
object.
The `FunctionName` functions are provided for convenience and return only the
response data.
## Example
```go
res, err := client.GetDataCenterDefaultNetworkWithResponse(ctx,
&katapult.GetDataCenterDefaultNetworkParams{
DataCenterPermalink: "perma-link",
},
)
```