Skip to content

Commit

Permalink
docs: point to openapi sdks
Browse files Browse the repository at this point in the history
  • Loading branch information
Dizzzmas committed Oct 28, 2024
1 parent 5c83d63 commit 46ce7c8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/ninety-bats-approve.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@dizzzmas/sst-url-shortener": patch
---

update docs to link to openapi sdks
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Host your own URL shortener on AWS with [SST](https://github.com/sst/sst) and chop up those beefy links in a breeze!

- :twisted_rightwards_arrows: Add as a component to your existing SST app or deploy standalone and integrate with your JS/Python/Go backend via the OpenAPI sdk
- :twisted_rightwards_arrows: Add as a component to your existing SST app or deploy standalone and integrate with your [JS](https://github.com/Dizzzmas/sst-url-shortener-js-sdk)/[Python](https://github.com/Dizzzmas/sst-url-shortener-python-sdk)/[Go](https://github.com/Dizzzmas/sst-url-shortener-go-sdk) backend via the OpenAPI sdk
- :lock: Opt-in API bearer auth and Swagger docs UI
- :sparkles: URL search and expiration support
- :house: Bring your custom domain
Expand Down Expand Up @@ -67,7 +67,12 @@ By default the API doesn't require authentication and has Swagger UI enabled.
We can visit `{api}/ui` to access the swagger UI and test our API.

### Backend integration via OpenAPI SDK
JS/Python/Go SDKs are available.
SDKs are available for:

- [JS](https://github.com/Dizzzmas/sst-url-shortener-js-sdk)
- [Python](https://github.com/Dizzzmas/sst-url-shortener-python-sdk)
- [Go](https://github.com/Dizzzmas/sst-url-shortener-go-sdk)

Below is an example of using the JS SDK to shorten a URL:

Install the SDK in your backend project
Expand Down

0 comments on commit 46ce7c8

Please sign in to comment.