{"id":22089827,"url":"https://github.com/speakeasy-api/speakeasy-tsoa-example","last_synced_at":"2026-03-01T04:06:33.862Z","repository":{"id":193516453,"uuid":"688896259","full_name":"speakeasy-api/speakeasy-tsoa-example","owner":"speakeasy-api","description":"An Example Repo showing OpenAPI generation from TsoA","archived":false,"fork":false,"pushed_at":"2025-08-04T20:56:11.000Z","size":166,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-01-24T01:46:08.041Z","etag":null,"topics":["openapi","sdk","tsoa"],"latest_commit_sha":null,"homepage":"https://speakeasyapi.dev/docs/api-frameworks/tsoa/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/speakeasy-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-09-08T10:32:13.000Z","updated_at":"2025-08-04T20:56:15.000Z","dependencies_parsed_at":"2023-09-08T14:46:53.738Z","dependency_job_id":"c344f964-898b-46ce-b2c0-dd12eac94694","html_url":"https://github.com/speakeasy-api/speakeasy-tsoa-example","commit_stats":null,"previous_names":["speakeasy-api/speakeasy-tsoa-example"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/speakeasy-api/speakeasy-tsoa-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fspeakeasy-tsoa-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fspeakeasy-tsoa-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fspeakeasy-tsoa-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fspeakeasy-tsoa-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-api","download_url":"https://codeload.github.com/speakeasy-api/speakeasy-tsoa-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fspeakeasy-tsoa-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29960173,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T01:47:18.291Z","status":"online","status_checked_at":"2026-03-01T02:00:07.437Z","response_time":124,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi","sdk","tsoa"],"created_at":"2024-12-01T02:14:24.165Z","updated_at":"2026-03-01T04:06:33.851Z","avatar_url":"https://github.com/speakeasy-api.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n \u003ca href=\"https://www.speakeasy.com/\" target=\"_blank\"\u003e\n  \u003cimg width=\"1500\" height=\"500\" alt=\"Speakeasy\" src=\"https://github.com/user-attachments/assets/0e56055b-02a3-4476-9130-4be299e5a39c\" /\u003e\n \u003c/a\u003e\n \u003cbr /\u003e\n \u003cbr /\u003e\n  \u003cdiv\u003e\n   \u003ca href=\"https://speakeasy.com/docs/create-client-sdks/\" target=\"_blank\"\u003e\u003cb\u003eDocs Quickstart\u003c/b\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;//\u0026nbsp;\u0026nbsp;\u003ca href=\"https://go.speakeasy.com/slack\" target=\"_blank\"\u003e\u003cb\u003eJoin us on Slack\u003c/b\u003e\u003c/a\u003e\n  \u003c/div\u003e\n \u003cbr /\u003e\n\n\u003c/div\u003e\n\n\n\u003ch2\u003eSpeakeasy tsoa OpenAPI Example\u003c/h2\u003e\n\n\n\nThis example tsoa app demonstrates Speakeasy-recommended practices for generating clear OpenAPI specifications and SDKs.\n\n## Prerequisites\n\nYou need to have Node.js and Yarn installed on your system to run this project. If you don't have these installed, you can download them from [here](https://nodejs.org/) and [here](https://yarnpkg.com/).\n\nTo generate an SDK, you'll also need the Speakeasy CLI installed, or use the Speakeasy dashboard.\n\n## Installation\n\nTo install the application on your local machine:\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/ritza-co/speakeasy-bar-tsoa.git\n```\n\n2. Navigate into the directory:\n```bash\ncd speakeasy-bar-tsoa\n```\n\n3. Install all dependencies for the application using Yarn:\n```bash\nyarn install\n```\n\n4. [Install Speakeasy CLI](https://github.com/speakeasy-api/speakeasy#installation):\n```bash\nbrew install speakeasy-api/homebrew-tap/speakeasy\n```\n\n## Running the application\n\n1. Compile the TypeScript files:\n```bash\nyarn build\n```\n\n2. Start the server:\n```bash\nyarn start\n```\n\n### For development\n\nYou 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 and update the routes and OpenAPI definition.\n\n```bash\nyarn dev\n```\n\n### Working with the OpenAPI specification\n\nIf you want to have a separate OpenAPI specification file in YAML format, run:\n\n```bash\nyarn spec\n```\n\nAdditionally, you can generate both the specification file and a TypeScript SDK for your API using:\n\n```bash\nyarn spec-and-sdk\n```\n\n## License\n\nThis project is licensed under the terms of the Apache 2.0 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fspeakeasy-tsoa-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-api%2Fspeakeasy-tsoa-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fspeakeasy-tsoa-example/lists"}