{"id":14979097,"url":"https://github.com/atpuxiner/fastapi-scaf","last_synced_at":"2025-05-16T12:02:27.905Z","repository":{"id":250798596,"uuid":"835573204","full_name":"atpuxiner/fastapi-scaf","owner":"atpuxiner","description":"This is a fastapi scaf. (fastapi脚手架，一键生成项目或api，让开发变得更简单)","archived":false,"fork":false,"pushed_at":"2025-04-21T07:05:24.000Z","size":149,"stargazers_count":204,"open_issues_count":3,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-21T07:42:21.761Z","etag":null,"topics":["fastapi","fastapi-scaf","python"],"latest_commit_sha":null,"homepage":"","language":"Python","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/atpuxiner.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}},"created_at":"2024-07-30T05:45:20.000Z","updated_at":"2025-04-21T07:05:27.000Z","dependencies_parsed_at":"2025-02-15T13:10:38.291Z","dependency_job_id":"ad699e2b-21aa-485a-8968-62a5747bdb41","html_url":"https://github.com/atpuxiner/fastapi-scaf","commit_stats":null,"previous_names":["atpuxiner/fastapi-scaf"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atpuxiner%2Ffastapi-scaf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atpuxiner%2Ffastapi-scaf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atpuxiner%2Ffastapi-scaf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atpuxiner%2Ffastapi-scaf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atpuxiner","download_url":"https://codeload.github.com/atpuxiner/fastapi-scaf/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254527074,"owners_count":22085918,"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":["fastapi","fastapi-scaf","python"],"created_at":"2024-09-24T13:59:13.354Z","updated_at":"2025-05-16T12:02:27.850Z","avatar_url":"https://github.com/atpuxiner.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fastapi-scaf\n\n## What is this?\n\n- by: axiner\n- fastapi-scaf\n- This is a fastapi scaf.\n    - new project\n    - add api\n    - about project:\n        - auto init project (conf, db, log...)\n        - auto register router\n        - auto register middleware\n        - ...\n    - more docs: [请点击链接](https://blog.csdn.net/atpuxiner/article/details/144291336?fromshare=blogdetail\u0026sharetype=blogdetail\u0026sharerId=144291336\u0026sharerefer=PC\u0026sharesource=atpuxiner\u0026sharefrom=from_link)\n\n## Project Structure\n\n- ABD: ABD模式\n    - A api\n    - B business\n    - D datatype\n- 调用过程: main.py(initializer) - router(middleware) - api - business - (datatype)\n- 结构如下: (命名经过多次修改敲定，简洁易懂，ABD目录贴合避免杂乱无章)\n  ```\n  └── fastapi-scaf\n      ├── app                         (应用)\n      │   ├── api                     ├── (api)\n      │   │   └── v1                  │   └── (v1)\n      │   ├── business                ├── (业务)\n      │   ├── datatype                ├── (数据类型)\n      │   ├── initializer             ├── (初始化)\n      │   │   ├── conf                │   ├── (配置)\n      │   │   ├── db                  │   ├── (数据库)\n      │   │   ├── log                 │   ├── (日志)\n      │   │   └── ...                 │   └── (...)\n      │   ├── middleware              ├── (中间件)\n      │   ├── router                  ├── (路由)\n      │   ├── utils                   ├── (utils)\n      │   └── main.py                 └── (main.py)\n      ├── config                      (配置目录)\n      ├── deploy                      (部署目录)\n      ├── docs                        (文档目录)\n      ├── log                         (日志目录)\n      ├── .gitignore\n      ├── LICENSE\n      ├── README.md\n      └── requirements.txt\n  ```\n\n## Installation\n\nThis package can be installed using pip (Python\u003e=3.11):\n\u003e pip install fastapi-scaf\n\n## Scaf Usage\n\n- 1）help document\n    - `fastapi-scaf -h`\n- 2）new project\n    - `fastapi-scaf new \u003cmyproj\u003e`\n- 3）add api\n    - `cd to project root dir`\n    - `fastapi-scaf add \u003cmyapi\u003e`\n\n## Project Run\n\n- 1）cd to project root dir\n- 2）modify the configuration, such as for the database\n- 3）`pip install -r requirements.txt`\n- 4）`python runserver.py`\n    - more parameters see:\n      - about uvicorn: [click here](https://www.uvicorn.org/)\n      - about gunicorn: [click here](https://docs.gunicorn.org/en/stable/)\n\n## LICENSE\n\nThis project is released under the MIT License (MIT). See [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatpuxiner%2Ffastapi-scaf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatpuxiner%2Ffastapi-scaf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatpuxiner%2Ffastapi-scaf/lists"}