{"id":20154907,"url":"https://github.com/ai-helpers/example-api-template","last_synced_at":"2026-04-18T09:31:42.893Z","repository":{"id":241933946,"uuid":"806482005","full_name":"ai-helpers/example-api-template","owner":"ai-helpers","description":"Instantiating the API cookiecutter template (FastAPI).","archived":false,"fork":false,"pushed_at":"2024-05-31T12:48:04.000Z","size":3099,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-13T12:42:06.097Z","etag":null,"topics":["example","fastapi","machine-learning"],"latest_commit_sha":null,"homepage":"https://ai-helpers.github.io/example-api-template/","language":"Python","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/ai-helpers.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,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-27T09:30:32.000Z","updated_at":"2025-01-11T06:57:30.000Z","dependencies_parsed_at":"2024-11-13T23:40:21.931Z","dependency_job_id":null,"html_url":"https://github.com/ai-helpers/example-api-template","commit_stats":null,"previous_names":["ai-helpers/example-api-template"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ai-helpers%2Fexample-api-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ai-helpers%2Fexample-api-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ai-helpers%2Fexample-api-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ai-helpers%2Fexample-api-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ai-helpers","download_url":"https://codeload.github.com/ai-helpers/example-api-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241593795,"owners_count":19987642,"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":["example","fastapi","machine-learning"],"created_at":"2024-11-13T23:28:59.223Z","updated_at":"2026-04-18T09:31:37.873Z","avatar_url":"https://github.com/ai-helpers.png","language":"Python","readme":"# **API - API Example**\n\n- **Template**: [AI Helpers API template](https://github.com/ai-helpers/api-cookiecutter-template)\n- **Description**: My project description\n\n## Table of Content (ToC)\n\n- [Table of Content (ToC)](#table-of-content-toc)\n- [Quickstart](#quickstart)\n- [Endpoints](#endpoints)\n  - [Health](#health)\n  - [Info](#info)\n  - [Predict](#predict)\n  - [Test](#test)\n  - [Documentation](#documentation)\n- [Project Structure](#project-structure)\n- [Contributions](#contributions)\n\n## Quickstart\n\n```bash\n$ poetry install\n[...]\nPackage operations: 44 installs, 0 updates, 0 removals\n[...]\n$ poetry run api-example\n[\\2024-05-28 15:58:59,332] {\\root} \\INFO - \\[API] Starting service with version 0.1.0...\n[\\2024-05-28 15:58:59,332] {\\root} \\INFO - \\[API] Log level set to DEBUG\n[\\2024-05-28 15:58:59,332] {\\api_example.cli} \\INFO - \\[API] Log level set to DEBUG\n[\\2024-05-28 15:58:59,332] {\\api_example.cli} \\INFO - \\[API] API service starting on 0.0.0.0:80\n[\\2024-05-28 15:59:15,529] {\\uvicorn.error} \\INFO - \\Started server process [98569]\n[\\2024-05-28 15:59:15,529] {\\uvicorn.error} \\INFO - \\Waiting for application startup.\n[\\2024-05-28 15:59:15,529] {\\uvicorn.error} \\INFO - \\Application startup complete.\n[\\2024-05-28 15:59:15,534] {\\uvicorn.error} \\INFO - \\Uvicorn running on http://0.0.0.0:80 (Press CTRL+C to quit)\n```\n\n## Endpoints\n\n### Health\nA simple endpoint to check the health of the application.\n```http\nGET /health\n```\nReturns a status message indicating the service is up and running.\n\n### Info\nProvides information about the application.\n```http\nGET /info\n```\nReturns metadata such as version, author, and other relevant details (cf. `data/info.txt`)\n\n### Predict\nEndpoint for making predictions based on input data.\n```http\nPOST /predict\n```\nAccepts a JSON payload with the necessary input data and returns the prediction results.\n\n### Test\nEndpoint for testing purposes.\n```http\nGET /test\n```\nReturns a test response, useful for debugging and ensuring the endpoint is reachable.\n\n### Documentation\nFastAPI provides interactive API documentation.\n```http\nGET /docs\n```\nAccess the Swagger UI for a user-friendly interface to interact with your API.\n\n```http\nGET /redoc\n```\nAccess the ReDoc interface for an alternative documentation style.\n\n## Project Structure\n\n    ├── api-example\n    │   ├── .github                                         \u003c- Github Actions CICD\n    │   ├── data\n    │   ├── docs                                            \u003c- Sphinx documentation\n    │   ├── src   \n    │       └── api_example   \u003c- Core of project\n    │   │       ├── endpoints                               \u003c- API endpoints definition\n    │   │       ├── settings                                \u003c- settings\n    │   │       ├── __init__.py      \n    │   │       ├── app.py           \n    │   │       ├── cli.py           \n    │   │       ├── errors           \n    │   │       ├── load_model.py    \n    │   │       └── setup_logging.py \n    │   ├── tasks                                           \u003c- Makefile tasks\n    │   ├── tests                                           \u003c- tests (units tests, data tests)\n    │   ├── .gitignore          \n    │   ├── .mypy.ini   \n    │   ├── Makefile   \n    │   ├── poetry.toml                       \n    │   ├── pyproject.toml   \n        └── README.md    \n\n## Contributions\n\nYour contributions are valued! Please feel free to open issues or submit pull requests.\n\nLet me know if you'd like any other sections added!","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fai-helpers%2Fexample-api-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fai-helpers%2Fexample-api-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fai-helpers%2Fexample-api-template/lists"}