Speakeasy ElysiaJS OpenAPI Example

This example ElysiaJS app demonstrates Speakeasy-recommended practices for creating clear OpenAPI specifications and SDKs.

This project has five example CRUD API endpoints in src/controllers/users.ts to get all users, get a user by id, create a user, delete a user, and update a user.

Prerequisites

You need to have Bun installed on your system to run this project.

To generate an SDK, you'll also need the Speakeasy CLI installed, or use the Speakeasy dashboard.

Installation

Install the application on your local machine:

1. Clone the repository:

git clone https://github.com/speakeasy-api/speakeasy-elysiajs-example.git

2. Navigate into the directory:

cd speakeasy-elysiajs-example

3. Install all dependencies for the application using Bun:

bun install

4. Install the Speakeasy CLI:

brew install speakeasy-api/homebrew-tap/speakeasy

Running the application

You can use the provided script to run the application in development mode. It will watch for any changes in the source code and automatically restart the server.

bun run dev

Creating an OpenAPI specification

Run the following command to create an OpenAPI spec YAML file in your root folder:

bun run create:openapi

Creating an SDK with Speakeasy

Run the following command to create a Speakeasy SDK:

speakeasy quickstart

License

This project is licensed under the terms of the Apache 2.0 license.