Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/stackone-sample-sdk
Example SDK for StackOne
https://github.com/speakeasy-sdks/stackone-sample-sdk
Last synced: 1 day ago
JSON representation
Example SDK for StackOne
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/stackone-sample-sdk
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-10-23T08:39:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:48:57.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:52.114Z (6 months ago)
- Language: Python
- Size: 345 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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.
3. 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://speakeasyapi.dev/docs/create-client-sdks/advanced-setup/github-setup/). 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/workspaces/cl6augut900003b6b06012z1s).
4. 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://speakeasyapi.dev/docs/package-publishing/).
5. 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.
6. 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
```python
import speakeasybar
from speakeasybar.models import operations, shared
s = speakeasybar.Speakeasybar(
security=shared.Security(
api_key="",
),
)
res = s.drinks.list_drinks(drink_type=shared.DrinkType.WINE)
if res.drinks is not None:
# handle response
```
## Available Resources and Operations
### [authentication](docs/sdks/authentication/README.md)
* [authenticate](docs/sdks/authentication/README.md#authenticate) - Authenticate with the API by providing a username and password.
### [config](docs/sdks/config/README.md)
* [subscribe_to_webhooks](docs/sdks/config/README.md#subscribe_to_webhooks) - Subscribe to webhooks.
### [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.
### 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)