{"id":25878241,"url":"https://github.com/codershubinc/open-api-ts","last_synced_at":"2025-07-04T16:06:59.626Z","repository":{"id":277738865,"uuid":"933348347","full_name":"codershubinc/open-api-TS","owner":"codershubinc","description":"This project is an open API implementation using TypeScript. Please Star the repo.    It provides a set of common data and utilities for various countries, including city names, first names, last names, and more.","archived":false,"fork":false,"pushed_at":"2025-06-26T06:13:08.000Z","size":388,"stargazers_count":9,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-26T07:24:08.023Z","etag":null,"topics":["api","backend","backend-api","colaboration","collaborate","github","nestjs","nodejs","server","serverless-framework","student-vscode","tech","ts"],"latest_commit_sha":null,"homepage":"https://open-api-ts.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codershubinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2025-02-15T18:34:09.000Z","updated_at":"2025-06-26T06:13:12.000Z","dependencies_parsed_at":"2025-03-10T18:28:25.203Z","dependency_job_id":"a967f7f6-a28b-4f8c-92aa-a28567795564","html_url":"https://github.com/codershubinc/open-api-TS","commit_stats":null,"previous_names":["codershubinc/open-api-ts"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/codershubinc/open-api-TS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codershubinc%2Fopen-api-TS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codershubinc%2Fopen-api-TS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codershubinc%2Fopen-api-TS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codershubinc%2Fopen-api-TS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codershubinc","download_url":"https://codeload.github.com/codershubinc/open-api-TS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codershubinc%2Fopen-api-TS/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263573218,"owners_count":23482609,"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":["api","backend","backend-api","colaboration","collaborate","github","nestjs","nodejs","server","serverless-framework","student-vscode","tech","ts"],"created_at":"2025-03-02T12:23:05.685Z","updated_at":"2025-07-04T16:06:59.621Z","avatar_url":"https://github.com/codershubinc.png","language":"TypeScript","readme":"# Open API TS\n\nThis project is an open API implementation using TypeScript. It provides a set of common data and utilities for various countries, including city names, first names, last names, and more.\n\n## Features\n\n- Common data for multiple countries\n- Utility functions for data handling\n- Modular structure for easy extension\n\n## API Endpoints\n\n### UserController\n\n#### Get User by Country\n\n- **URL:** `/user/:country`\n- **Method:** `GET`\n- **URL Params:** \n  - `country=[string]` (required)\n- **Success Response:**\n  - **Code:** 200\n  - **Content:** \n    ```json\n    {\n      \"FirstName\": \"John\",\n      \"LastName\": \"Doe\",\n      \"Gender\": \"male\",\n      \"Email\": \"john.doe@codershubinc.tech\",\n      \"Phone\": \"123-456-7890\",\n      \"Address\": {\n        \"Street\": \"123 Main St\",\n        \"City\": \"Anytown\",\n        \"State\": \"Anystate\",\n        \"Zip\": \"12345\"\n      }\n    }\n    ```\n- **Error Response:**\n  - **Code:** 404 NOT FOUND\n  - **Content:** \n    ```json\n    {\n      \"status\": \"error\",\n      \"message\": \"Country not found\"\n    }\n    ```\n  - **Code:** 500 INTERNAL SERVER ERROR\n  - **Content:** \n    ```json\n    {\n      \"status\": \"error\",\n      \"message\": \"Internal server error\"\n    }\n    ```\n\n#### Example Request\n\n```bash\ncurl -X GET \"http://localhost:3000/user/US\"\n```\n\n#### Example Response\n\n```json\n{\n  \"FirstName\": \"John\",\n  \"LastName\": \"Doe\",\n  \"Gender\": \"male\",\n  \"Email\": \"john.doe@codershubinc.tech\",\n  \"Phone\": \"123-456-7890\",\n  \"Address\": {\n    \"Street\": \"123 Main St\",\n    \"City\": \"Anytown\",\n    \"State\": \"Anystate\",\n    \"Zip\": \"12345\"\n  }\n}\n```\n\n## Dependencies\n\n- @nestjs/common: ^10.0.0\n- @nestjs/core: ^10.0.0\n- @nestjs/platform-express: ^10.0.0\n- axios: ^1.8.1\n- reflect-metadata: ^0.2.0\n- rxjs: ^7.8.1\n\n## Getting Started\n\nTo get started with this project, clone the repository and install the dependencies:\n\n```bash\n$ git clone \u003crepository-url\u003e\n$ cd open-api-TS\n$ bun install or $ npm install\n```\n\n## Running Tests\n\nTo run tests, use the provided scripts in `package.json`:\n\n```bash\n$ npm test\n$ npm run test:watch\n$ npm run test:cov\n$ npm run test:debug\n$ npm run test:e2e\n```\n\nFor more information on the available API endpoints, please refer to the [API Endpoints Documentation](src/api/v0.1/api-endpoints.md).\n\n## Contributing\n\nWe welcome contributions! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute to this project.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodershubinc%2Fopen-api-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodershubinc%2Fopen-api-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodershubinc%2Fopen-api-ts/lists"}