Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/practical-ink-sample-sdk
A go SDK for accessing the TechPort API.
https://github.com/speakeasy-sdks/practical-ink-sample-sdk
Last synced: 1 day ago
JSON representation
A go SDK for accessing the TechPort API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/practical-ink-sample-sdk
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-10-15T21:34:21.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:47:32.000Z (7 months ago)
- Last Synced: 2024-08-24T00:22:59.254Z (3 months ago)
- Language: Go
- Size: 87.9 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# github.com/speakeasy-sdks/Practical-ink-sample-sdk
## 🏗 **Welcome to your new SDK!** 🏗
It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
## SDK Installation
```bash
go get github.com/speakeasy-sdks/Practical-ink-sample-sdk
```
## SDK Example Usage
### Example
```go
package main
import (
"context"
practicalinksamplesdk "github.com/speakeasy-sdks/Practical-ink-sample-sdk"
"log"
)
func main() {
s := practicalinksamplesdk.New()
ctx := context.Background()
res, err := s.GetAPI(ctx)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
```
## Available Resources and Operations
### [TechPort SDK](docs/sdks/techport/README.md)
* [GetAPI](docs/sdks/techport/README.md#getapi) - Returns the swagger specification for the API.
* [GetAPIProjectsIDFormat](docs/sdks/techport/README.md#getapiprojectsidformat) - Returns information about a specific technology project.
* [GetAPIProjectsFormat](docs/sdks/techport/README.md#getapiprojectsformat) - Returns a list of available technology project IDs.
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both. When specified by the OpenAPI spec document, the SDK will return the appropriate subclass.
| Error Object | Status Code | Content Type |
| ------------------ | ------------------ | ------------------ |
| sdkerrors.SDKError | 4xx-5xx | */* |
### Example
```go
package main
import (
"context"
"errors"
practicalinksamplesdk "github.com/speakeasy-sdks/Practical-ink-sample-sdk"
"github.com/speakeasy-sdks/Practical-ink-sample-sdk/models/sdkerrors"
"log"
)
func main() {
s := practicalinksamplesdk.New()
ctx := context.Background()
res, err := s.GetAPI(ctx)
if err != nil {
var e *sdkerrors.SDKError
if errors.As(err, &e) {
// handle error
log.Fatal(e.Error())
}
}
}
```
## Server Selection
### Select Server by Index
You can override the default server globally using the `WithServerIndex` option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `http://techport.nasa.gov/api` | None |
| 1 | `https://techport.nasa.gov/api` | None |
#### Example
```go
package main
import (
"context"
practicalinksamplesdk "github.com/speakeasy-sdks/Practical-ink-sample-sdk"
"log"
)
func main() {
s := practicalinksamplesdk.New(
practicalinksamplesdk.WithServerIndex(1),
)
ctx := context.Background()
res, err := s.GetAPI(ctx)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
```
### Override Server URL Per-Client
The default server can also be overridden globally using the `WithServerURL` option when initializing the SDK client instance. For example:
```go
package main
import (
"context"
practicalinksamplesdk "github.com/speakeasy-sdks/Practical-ink-sample-sdk"
"log"
)
func main() {
s := practicalinksamplesdk.New(
practicalinksamplesdk.WithServerURL("http://techport.nasa.gov/api"),
)
ctx := context.Background()
res, err := s.GetAPI(ctx)
if err != nil {
log.Fatal(err)
}
if res != nil {
// handle response
}
}
```
## Custom HTTP Client
The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:
```go
type HTTPClient interface {
Do(req *http.Request) (*http.Response, error)
}
```
The built-in `net/http` client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.
```go
import (
"net/http"
"time"
"github.com/myorg/your-go-sdk"
)
var (
httpClient = &http.Client{Timeout: 30 * time.Second}
sdkClient = sdk.New(sdk.WithClient(httpClient))
)
```
This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.
## Special Types
This SDK defines the following custom types to assist with marshalling and unmarshalling data.
### Date
`types.Date` is a wrapper around time.Time that allows for JSON marshaling a date string formatted as "2006-01-02".
#### Usage
```go
d1 := types.NewDate(time.Now()) // returns *types.Date
d2 := types.DateFromTime(time.Now()) // returns types.Date
d3, err := types.NewDateFromString("2019-01-01") // returns *types.Date, error
d4, err := types.DateFromString("2019-01-01") // returns types.Date, error
d5 := types.MustNewDateFromString("2019-01-01") // returns *types.Date and panics on error
d6 := types.MustDateFromString("2019-01-01") // returns types.Date and panics on error
```
# Development
## Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
## Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)