{"id":22812851,"url":"https://github.com/nishantcoder108/tsoa-open-api","last_synced_at":"2025-10-25T16:04:14.889Z","repository":{"id":191042370,"uuid":"683809633","full_name":"NishantCoder108/tsoa-open-api","owner":"NishantCoder108","description":"This repository hosts a sophisticated API project developed using Tsoa, a TypeScript library that streamlines API creation, combined with the power of Swagger UI for interactive API documentation. The project demonstrates a well-structured API implementation, complete with automatic routing,  and documentation generation.","archived":false,"fork":false,"pushed_at":"2023-08-27T21:34:27.000Z","size":80,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-30T21:41:48.851Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NishantCoder108.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-08-27T19:07:46.000Z","updated_at":"2023-08-27T19:10:44.000Z","dependencies_parsed_at":"2023-08-27T20:46:03.773Z","dependency_job_id":"a43442f2-8fa0-421a-8ae0-13b1d9f68018","html_url":"https://github.com/NishantCoder108/tsoa-open-api","commit_stats":null,"previous_names":["nishantcoder108/tsoa-open-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/NishantCoder108/tsoa-open-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NishantCoder108%2Ftsoa-open-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NishantCoder108%2Ftsoa-open-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NishantCoder108%2Ftsoa-open-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NishantCoder108%2Ftsoa-open-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NishantCoder108","download_url":"https://codeload.github.com/NishantCoder108/tsoa-open-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NishantCoder108%2Ftsoa-open-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260035588,"owners_count":22949253,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-12-12T12:13:59.459Z","updated_at":"2025-10-25T16:04:09.854Z","avatar_url":"https://github.com/NishantCoder108.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":" \u003ch3 align=\"center\"\u003eTsoa OpenAPI Project with Swagger UI\u003c/h3\u003e\n\n\u003c!-- TABLE OF CONTENTS\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n   \n   \n  \u003c/ol\u003e\n\u003c/details\u003e\n --\u003e\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n## About The Project\n![Tsoa OpenAPI Project with Swagger UI](https://github.com/NishantCoder108/tsoa-open-api/assets/69218488/e9a54504-fe89-4208-a8c8-11b707eaceca)\n\n\n\nThis repository showcases an advanced API project crafted with Tsoa, a TypeScript library that simplifies API development. This project is enriched with Swagger UI, which offers interactive documentation. It displays a meticulously organized API setup, including automatic routing, validation, and documentation generation.\n\n**Highlights:**\n\n- **Tsoa Empowerment**: Built using Tsoa, the project exemplifies a streamlined API structure. Tsoa takes care of routing, validation, and more, enhancing efficiency.\n\n- **Engaging Swagger UI**: Swagger UI integration provides a dynamic API documentation experience. It reveals routes, parameters, and responses, facilitating real-time testing.\n\n- **Practical TypeScript**: TypeScript's robust typing enriches the project, enhancing code quality and error prevention.\n\n- **Seamless Usage**: Clone the repository, install dependencies, and launch the API server to access Swagger UI for exploration.\n\nContributions: Contributions are welcome via pull requests or issue submissions.\n\nLicense: The project is licensed under MIT, ensuring freedom for usage and modification.\n\n\n\u003cbr /\u003e\n\n**Usage Instructions**:\n\n1. Clone the repository to your local machine using the command: `git clone [repository-url]`.\n2. Navigate to the project directory: `cd tsoa-open-api`.\n3. Install dependencies: `npm install` or `yarn install`.\n4. Start the API server: `npm run dev` or `yarn dev`.\n5. Access Swagger UI in your browser at `http://localhost:3000/docs/`.\n\n\u003cbr /\u003e\nFor starting this project , you follow `https://tsoa-community.github.io/docs/getting-started.html` ,it can help to complete tsoa open api project. \n\n\nand I highly recommended to go through this link, `https://www.linkedin.com/pulse/unveiling-power-tsoa-swagger-ui-crafting-exceptional-api-kumar/` for basic knowledge.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnishantcoder108%2Ftsoa-open-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnishantcoder108%2Ftsoa-open-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnishantcoder108%2Ftsoa-open-api/lists"}