{"id":21009425,"url":"https://github.com/shangsky/flask-sugar","last_synced_at":"2026-01-14T09:03:25.018Z","repository":{"id":39449053,"uuid":"385495819","full_name":"ShangSky/flask-sugar","owner":"ShangSky","description":"Flask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints. check parameters and generate API documents automatically. Flask Sugar是一个基于flask,pydantic,类型注解的API框架, 可以检查参数并自动生成API文档","archived":true,"fork":false,"pushed_at":"2022-04-29T07:45:08.000Z","size":1805,"stargazers_count":166,"open_issues_count":0,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-30T14:53:00.211Z","etag":null,"topics":["flask","openapi","python","swagger"],"latest_commit_sha":null,"homepage":"flask-sugar.vercel.app","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/ShangSky.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}},"created_at":"2021-07-13T06:12:39.000Z","updated_at":"2025-04-19T09:28:00.000Z","dependencies_parsed_at":"2022-09-08T03:41:36.550Z","dependency_job_id":null,"html_url":"https://github.com/ShangSky/flask-sugar","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/ShangSky/flask-sugar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShangSky%2Fflask-sugar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShangSky%2Fflask-sugar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShangSky%2Fflask-sugar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShangSky%2Fflask-sugar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ShangSky","download_url":"https://codeload.github.com/ShangSky/flask-sugar/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ShangSky%2Fflask-sugar/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28414733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T08:38:59.149Z","status":"ssl_error","status_checked_at":"2026-01-14T08:38:43.588Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["flask","openapi","python","swagger"],"created_at":"2024-11-19T09:16:44.068Z","updated_at":"2026-01-14T09:03:25.003Z","avatar_url":"https://github.com/ShangSky.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask Sugar\n\n- [简体中文](README_zh.md)\n\nFlask Sugar is a web framework for building APIs with Flask, Pydantic and Python 3.6+ type hints.\n\ncheck parameters and generate API documents automatically\n\nDocumentation: \u003chttps://shangsky.github.io/flask-sugar\u003e or \u003chttps://flask-sugar.vercel.app/\u003e\n\nSource Code: \u003chttps://github.com/shangsky/flask-sugar\u003e\n\n\n## Requirements\n\n- Python 3.6+\n- Flask 2.0+\n\n## Installation\n\n```shell\n$ pip install flask-sugar\n```\n\n## Example\n\n```python\n# save this as app.py\nfrom flask_sugar import Sugar, Header\nfrom pydantic import BaseModel\n\napp = Sugar(__name__)\n\n\nclass Item(BaseModel):\n    name: str\n    size: int\n\n\nclass Resp(BaseModel):\n    a: int\n    b: str\n    c: str\n    item: Item\n\n\n@app.post(\"/item/\u003ca\u003e\")\ndef demo(\n    a: int,  # path param\n    item: Item,  # json body param\n    b: str = \"default_query_param_b\",  # query param\n    c: str = Header(\"default_header_param_b\"),  # request header param\n) -\u003e Resp:\n    \"\"\"demo page\"\"\"\n    return Resp(a=a, b=b, c=c, item=item)\n```\n\n```shell\n$ flask run --reload\n  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)\n```\n\nNow visit the API documentation with Swagger UI at http://localhost:5000/doc:\n\n![](https://github.com/ShangSky/flask-sugar/raw/main/docs/img/swagger-ui.png)\n\nvisit the API documentation with Redoc at http://localhost:5000/redoc:\n\n![](https://github.com/ShangSky/flask-sugar/blob/main/docs/img/redoc.png)\n\n## License\n\nThis project is licensed under the terms of the MIT license.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshangsky%2Fflask-sugar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshangsky%2Fflask-sugar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshangsky%2Fflask-sugar/lists"}