Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/template-sdk
(TEMPLATE, Clone this repo to get started) Example of a Speakeasy Managed SDK
https://github.com/speakeasy-sdks/template-sdk
managed-sdk openapi openapi3 sdk speakeasy-api vendor-extensions
Last synced: 1 day ago
JSON representation
(TEMPLATE, Clone this repo to get started) Example of a Speakeasy Managed SDK
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/template-sdk
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-02-21T18:56:21.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-08T15:05:36.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:52.606Z (6 months ago)
- Topics: managed-sdk, openapi, openapi3, sdk, speakeasy-api, vendor-extensions
- Language: TypeScript
- Homepage: https://speakeasyapi.dev/docs/using-speakeasy/create-client-sdks/intro/
- Size: 563 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security.md
Awesome Lists containing this project
README
# Template SDK
## How to use this repository
**👀** This template repository is designed to bootstrap a [Speakeasy managed SDK repository](https://speakeasyapi.dev/docs/create-client-sdks/) using Github's repository clone feature. Once this repository is setup it will automatically keep your SDK up to date and published to a package manager.
### Creating an SDK
1. To get started, simply clone the repository by clicking on the "Use template" button and give it a name.
2. Configure the Speakeasy workflow to generate the SDK. Go to the [generation workflow file](https://github.com/speakeasy-sdks/template-sdk/blob/main/.github/workflows/speakeasy_sdk_generation.yml) and configure the `language`, `mode` and `location` of your openapi document. For complete documentation on all the available generation configurations, see [here](https://www.speakeasyapi.dev/docs/advanced-setup/sdk-automation). You will also need to add a `SPEAKEASY_API_KEY` as a repository secret. If you don't already have a key you can get one by making a workspace on Speakeasy [here](https://app.speakeasyapi.dev/).
3. Configure the Speakeasy workflow to publish the SDK. Go to the [publishing workflow file](https://github.com/speakeasy-sdks/template-sdk/blob/main/.github/workflows/speakeasy_sdk_publish.yml) and configure any relevant package manager credentials as repository secrets. For complete documentation on all the available publishing configurations, see [here](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks).
4. Configure the generation by editing the `gen.yaml` file in the root of the repo. This file controls the generator and determines various attributes of the SDK like `packageName`, `sdkClassName`, inlining of parameters, and other ergonomics.
5. Finally go to the Actions tab, choose the generation workflow and click "Force Generate". This will trigger a new generation of your SDK using the configuration you provided above. Depending on whether you configured `pr` or `direct` mode above your updated SDK will appear in PR or in the main branch.
🚀 You should have a working SDK for your API 🙂 . To check out all the features of the SDK please see our docs [site](https://speakeasyapi.dev/docs/create-client-sdks/).
### Local development
Once you have the SDK setup you may want to iterate on the SDK. Speakeasy supports OpenAPI vendor extensions that can be added to your spec to customize the SDK ergonomics (method names, namespacing resources etc.) and functionality (adding retries, pagination, multiple server support etc)
To get started install the Speakeasy CLI.
In your terminal, run:
```bash
brew install speakeasy-api/homebrew-tap/speakeasy
```
Once you annonate your spec with an extension you will want to run `speakeasy validate` to check the spec for correctness and `speakeasy generate` to recreate the SDK locally. More documentation on OpenAPI extensions [here](https://speakeasyapi.dev/docs/customize-sdks/namespaces/). Here's an example of adding a multiple server support to the spec so that your SDK supports production and sandbox versions of your API.
```yaml
info:
title: Example
version: 0.0.1
servers:
- url: https://prod.example.com # Used as the default URL by the SDK
description: Our production environment
x-speakeasy-server-id: prod
- url: https://sandbox.example.com
description: Our sandbox environment
x-speakeasy-server-id: sandbox
```
Once you're finished iterating and happy with the output push only the latest version of spec into the repo and regenerate the SDK using step 6 above.
## SDK Installation
```bash
pip install git+https://github.com/speakeasy-sdks/template-sdk.git
```
## SDK Example Usage
### Sign in
First you need to send an authentication request to the API by providing your username and password.
In the request body, you should specify the type of token you would like to receive: API key or JSON Web Token.
If your credentials are valid, you will receive a token in the response object: `res.object.token: str`.
```python
import speakeasybar
from speakeasybar.models import operations
s = speakeasybar.Speakeasybar()
req = operations.LoginRequestBody(
type=operations.Type.API_KEY,
)
res = s.authentication.login(req, operations.LoginSecurity(
password="",
username="",
))
if res.object is not None:
# handle response
pass
```
### Browse available drinks
Once you are authenticated, you can use the token you received for all other authenticated endpoints.
For example, you can filter the list of available drinks by type.
```python
import speakeasybar
from speakeasybar.models import shared
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
res = s.drinks.list_drinks(drink_type=shared.DrinkType.SPIRIT)
if res.classes is not None:
# handle response
pass
```
### Create an order
When you submit an order, you can include a callback URL along your request.
This URL will get called whenever the supplier updates the status of your order.
```python
import speakeasybar
from speakeasybar.models import shared
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
res = s.orders.create_order(request_body=[
shared.OrderInput(
product_code='APM-1F2D3',
quantity=26535,
type=shared.OrderType.DRINK,
),
], callback_url='')
if res.order is not None:
# handle response
pass
```
### Subscribe to webhooks to receive stock updates
```python
import speakeasybar
from speakeasybar.models import operations, shared
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
req = [
operations.RequestBody(),
]
res = s.config.subscribe_to_webhooks(req)
if res is not None:
# handle response
pass
```
## Available Resources and Operations
### [authentication](docs/sdks/authentication/README.md)
* [login](docs/sdks/authentication/README.md#login) - Authenticate with the API by providing a username and password.
### [drinks](docs/sdks/drinks/README.md)
* [get_drink](docs/sdks/drinks/README.md#get_drink) - Get a drink.
* [list_drinks](docs/sdks/drinks/README.md#list_drinks) - Get a list of drinks.
### [ingredients](docs/sdks/ingredients/README.md)
* [list_ingredients](docs/sdks/ingredients/README.md#list_ingredients) - Get a list of ingredients.
### [orders](docs/sdks/orders/README.md)
* [create_order](docs/sdks/orders/README.md#create_order) - Create an order.
### [config](docs/sdks/config/README.md)
* [subscribe_to_webhooks](docs/sdks/config/README.md#subscribe_to_webhooks) - Subscribe to webhooks.
## Retries
Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:
```python
import speakeasybar
from speakeasybar.models import operations, shared
from speakeasybar.utils import BackoffStrategy, RetryConfig
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
req = [
operations.RequestBody(),
]
res = s.config.subscribe_to_webhooks(req,
RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False))
if res is not None:
# handle response
pass
```
If you'd like to override the default retry strategy for all operations that support retries, you can use the `retry_config` optional parameter when initializing the SDK:
```python
import speakeasybar
from speakeasybar.models import operations, shared
from speakeasybar.utils import BackoffStrategy, RetryConfig
s = speakeasybar.Speakeasybar(
retry_config=RetryConfig('backoff', BackoffStrategy(1, 50, 1.1, 100), False)
security=shared.Security(
api_key="",
),
)
req = [
operations.RequestBody(),
]
res = s.config.subscribe_to_webhooks(req)
if res is not None:
# handle response
pass
```
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
| Error Object | Status Code | Content Type |
| ----------------- | ----------------- | ----------------- |
| errors.BadRequest | 400 | application/json |
| errors.APIError | 5XX | application/json |
| errors.SDKError | 4xx-5xx | */* |
### Example
```python
import speakeasybar
from speakeasybar.models import errors, operations, shared
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
req = [
operations.RequestBody(),
]
res = None
try:
res = s.config.subscribe_to_webhooks(req)
except errors.BadRequest as e:
# handle exception
raise(e)
except errors.APIError as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res is not None:
# handle response
pass
```
## Server Selection
### Select Server by Name
You can override the default server globally by passing a server name to the `server: str` optional parameter 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 names associated with the available servers:
| Name | Server | Variables |
| ----- | ------ | --------- |
| `prod` | `https://speakeasy.bar` | None |
| `staging` | `https://staging.speakeasy.bar` | None |
| `customer` | `https://{organization}.{environment}.speakeasy.bar` | `environment` (default is `prod`), `organization` (default is `api`) |
#### Example
```python
import speakeasybar
from speakeasybar.models import shared
s = speakeasybar.Speakeasybar(
server="customer",
security=shared.Security(
api_key="",
),
)
res = s.ingredients.list_ingredients(ingredients=[
'',
])
if res.classes is not None:
# handle response
pass
```
#### Variables
Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
* `environment: models.ServerEnvironment`
* `organization: str`
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
import speakeasybar
from speakeasybar.models import shared
s = speakeasybar.Speakeasybar(
server_url="https://speakeasy.bar",
security=shared.Security(
api_key="",
),
)
res = s.ingredients.list_ingredients(ingredients=[
'',
])
if res.classes is not None:
# handle response
pass
```
### Override Server URL Per-Operation
The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:
```python
import speakeasybar
from speakeasybar.models import shared
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
res = s.drinks.list_drinks(server_url="https://speakeasy.bar", drink_type=shared.DrinkType.SPIRIT)
if res.classes is not None:
# handle response
pass
```
## Custom HTTP Client
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
For example, you could specify a header for every request that this sdk makes as follows:
```python
import speakeasybar
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = speakeasybar.Speakeasybar(client=http_client)
```
## Authentication
### Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
| ------------- | ------------- | ------------- |
| `api_key` | apiKey | API key |
| `bearer_auth` | http | HTTP Bearer |
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```python
import speakeasybar
from speakeasybar.models import shared
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
res = s.ingredients.list_ingredients(ingredients=[
'',
])
if res.classes is not None:
# handle response
pass
```
### Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
```python
import speakeasybar
from speakeasybar.models import operations
s = speakeasybar.Speakeasybar()
req = operations.LoginRequestBody(
type=operations.Type.API_KEY,
)
res = s.authentication.login(req, operations.LoginSecurity(
password="",
username="",
))
if res.object is not None:
# handle response
pass
```
### 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)