lambapi


Namelambapi JSON
Version 0.2.3 PyPI version JSON
download
home_pagehttps://github.com/sskyh0208/lambapi
Summaryモダンな AWS Lambda 用 API フレームワーク
upload_time2025-08-11 05:26:00
maintainerNone
docs_urlNone
authorYoshihiro Sasaki
requires_python>=3.10
licenseMIT
keywords lambda api aws serverless http rest
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # lambapi

**モダンな AWS Lambda 用 API フレームワーク**

![Python](https://img.shields.io/badge/python-3.10+-blue.svg)
![Version](https://img.shields.io/badge/version-0.2.2-green.svg)
![License](https://img.shields.io/badge/license-MIT-blue.svg)

AWS Lambda で直感的でモダンな API を構築できる軽量フレームワーク。パスパラメータとクエリパラメータの自動注入、型変換、CORS サポートを標準提供。

## ✨ 主な特徴

- 🚀 **直感的な記法** - デコレータベースのシンプルなルート定義
- 📋 **自動パラメータ注入** - パス・クエリパラメータを関数引数として直接受け取り
- 🔄 **型自動変換** - `int`、`float`、`bool`、`str` の自動型変換
- 🛡️ **バリデーション機能** - リクエストパラメータの自動バリデーションとエラーレスポンス
- 🌐 **CORS サポート** - プリフライトリクエストの自動処理
- 🔐 **認証システム** - DynamoDB + JWT による完全な認証・認可機能
- 🛡️ **構造化エラーハンドリング** - 本番運用に適した統一エラーレスポンス
- 📦 **軽量** - 標準ライブラリのみ、外部依存なし(認証機能は別途)
- 🔒 **型安全** - 完全な型ヒント対応

## 🚀 クイックスタート

### インストール

```bash
# 基本インストール
pip install lambapi

# ローカル開発環境(uvicorn 付き)
pip install lambapi[dev]

# または uvicorn を個別にインストール
pip install lambapi uvicorn[standard]
```

### 基本的な使用例

```python
from lambapi import API, create_lambda_handler, Query, Path, Body
from dataclasses import dataclass
from typing import Optional

@dataclass
class CreateUserRequest:
    name: str
    email: str
    age: Optional[int] = None

def create_app(event, context):
    app = API(event, context)

    @app.get("/")
    def hello():
        return {"message": "Hello, lambapi!"}

    @app.get("/search")
    def search(
        query: str = Query(..., description="検索クエリ", min_length=1),
        limit: int = Query(10, ge=1, le=100, description="結果数"),
        category: str = Query("all", description="カテゴリー")
    ):
        return {"query": query, "limit": limit, "category": category}

    @app.post("/users")
    def create_user(user_data: CreateUserRequest = Body(...)):
        return {
            "message": "ユーザーが作成されました",
            "user": {"name": user_data.name, "email": user_data.email}
        }

    return app

lambda_handler = create_lambda_handler(create_app)
```

### ローカル開発

lambapi は uvicorn を使用した高性能なローカル開発サーバーを提供します。AWS Lambda と API Gateway の環境を完全に再現し、本番環境と同等の動作を保証します。

```bash
# 新しいプロジェクトを作成
lambapi create my-api --template basic

# 高性能ローカルサーバーを起動(uvicorn + ホットリロード付き)
lambapi serve app

# カスタムポート・ホスト設定
lambapi serve app --host 0.0.0.0 --port 8080

# 詳細ログでデバッグ
lambapi serve app --debug --log-level debug

# API 動作確認
curl http://localhost:8000/
curl -X POST http://localhost:8000/users -H "Content-Type: application/json" -d '{"name":"test"}'
```

**uvicorn 統合の利点**:
- 🚀 **高性能** - 非同期 ASGI ベースで高速レスポンス
- 🔄 **ホットリロード** - コード変更を即座に反映
- 🌐 **API Gateway 互換** - 本番環境と同等のリクエスト/レスポンス形式
- 📊 **詳細ログ** - リクエスト詳細とエラー情報の表示
- ⚙️ **豊富な設定** - ワーカー数、ログレベル等のカスタマイズ可能

## 📚 ドキュメント

完全なドキュメントは **[https://sskyh0208.github.io/lambapi/](https://sskyh0208.github.io/lambapi/)** で公開されています。

<div class="grid cards" markdown>

-   🚀 **[クイックスタート](https://sskyh0208.github.io/lambapi/getting-started/quickstart/)**

    5 分で最初の API を構築

-   📖 **[チュートリアル](https://sskyh0208.github.io/lambapi/tutorial/basic-api/)**

    実際のコード例で機能を学習

-   🔧 **[API リファレンス](https://sskyh0208.github.io/lambapi/api/api/)**

    すべてのクラスとメソッドの詳細

-   🏗️ **[デプロイメント](https://sskyh0208.github.io/lambapi/guides/deployment/)**

    本番環境での運用とベストプラクティス

</div>

## 💡 なぜ lambapi?

### 従来の問題

```python
# 従来の Lambda ハンドラー(煩雑)
def lambda_handler(event, context):
    method = event['httpMethod']
    path = event['path']
    query_params = event.get('queryStringParameters', {}) or {}
    limit = int(query_params.get('limit', 10))  # 手動型変換

    if method == 'GET' and path == '/users':
        # 複雑なルーティング...
        pass

    return {
        'statusCode': 200,
        'headers': {'Content-Type': 'application/json'},
        'body': json.dumps({'data': 'result'})
    }
```

### lambapi なら

```python
# lambapi 版(シンプル)
@app.get("/users")
def get_users(limit: int):
    return {"users": [f"user-{i}" for i in range(limit)]}
```



## 🤝 コミュニティ

- 📁 **[GitHub](https://github.com/sskyh0208/lambapi)** - ソースコード・ Issues ・ Discussions
- 📦 **[PyPI](https://pypi.org/project/lambapi/)** - パッケージダウンロード
- 📚 **[ドキュメント](https://sskyh0208.github.io/lambapi/)** - 完全な使用ガイド

## 📄 ライセンス

MIT License - 詳細は [LICENSE](LICENSE) ファイルを参照

<!-- Generated by Claude 🤖 -->

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/sskyh0208/lambapi",
    "name": "lambapi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "lambda, api, aws, serverless, http, rest",
    "author": "Yoshihiro Sasaki",
    "author_email": "sskyh1988@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/2d/f2/1e90b8dd200a01dbbdbe0145faa6148b4d5a920e4cc3707c3da390c71211/lambapi-0.2.3.tar.gz",
    "platform": null,
    "description": "# lambapi\n\n**\u30e2\u30c0\u30f3\u306a AWS Lambda \u7528 API \u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af**\n\n![Python](https://img.shields.io/badge/python-3.10+-blue.svg)\n![Version](https://img.shields.io/badge/version-0.2.2-green.svg)\n![License](https://img.shields.io/badge/license-MIT-blue.svg)\n\nAWS Lambda \u3067\u76f4\u611f\u7684\u3067\u30e2\u30c0\u30f3\u306a API \u3092\u69cb\u7bc9\u3067\u304d\u308b\u8efd\u91cf\u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af\u3002\u30d1\u30b9\u30d1\u30e9\u30e1\u30fc\u30bf\u3068\u30af\u30a8\u30ea\u30d1\u30e9\u30e1\u30fc\u30bf\u306e\u81ea\u52d5\u6ce8\u5165\u3001\u578b\u5909\u63db\u3001CORS \u30b5\u30dd\u30fc\u30c8\u3092\u6a19\u6e96\u63d0\u4f9b\u3002\n\n## \u2728 \u4e3b\u306a\u7279\u5fb4\n\n- \ud83d\ude80 **\u76f4\u611f\u7684\u306a\u8a18\u6cd5** - \u30c7\u30b3\u30ec\u30fc\u30bf\u30d9\u30fc\u30b9\u306e\u30b7\u30f3\u30d7\u30eb\u306a\u30eb\u30fc\u30c8\u5b9a\u7fa9\n- \ud83d\udccb **\u81ea\u52d5\u30d1\u30e9\u30e1\u30fc\u30bf\u6ce8\u5165** - \u30d1\u30b9\u30fb\u30af\u30a8\u30ea\u30d1\u30e9\u30e1\u30fc\u30bf\u3092\u95a2\u6570\u5f15\u6570\u3068\u3057\u3066\u76f4\u63a5\u53d7\u3051\u53d6\u308a\n- \ud83d\udd04 **\u578b\u81ea\u52d5\u5909\u63db** - `int`\u3001`float`\u3001`bool`\u3001`str` \u306e\u81ea\u52d5\u578b\u5909\u63db\n- \ud83d\udee1\ufe0f **\u30d0\u30ea\u30c7\u30fc\u30b7\u30e7\u30f3\u6a5f\u80fd** - \u30ea\u30af\u30a8\u30b9\u30c8\u30d1\u30e9\u30e1\u30fc\u30bf\u306e\u81ea\u52d5\u30d0\u30ea\u30c7\u30fc\u30b7\u30e7\u30f3\u3068\u30a8\u30e9\u30fc\u30ec\u30b9\u30dd\u30f3\u30b9\n- \ud83c\udf10 **CORS \u30b5\u30dd\u30fc\u30c8** - \u30d7\u30ea\u30d5\u30e9\u30a4\u30c8\u30ea\u30af\u30a8\u30b9\u30c8\u306e\u81ea\u52d5\u51e6\u7406\n- \ud83d\udd10 **\u8a8d\u8a3c\u30b7\u30b9\u30c6\u30e0** - DynamoDB + JWT \u306b\u3088\u308b\u5b8c\u5168\u306a\u8a8d\u8a3c\u30fb\u8a8d\u53ef\u6a5f\u80fd\n- \ud83d\udee1\ufe0f **\u69cb\u9020\u5316\u30a8\u30e9\u30fc\u30cf\u30f3\u30c9\u30ea\u30f3\u30b0** - \u672c\u756a\u904b\u7528\u306b\u9069\u3057\u305f\u7d71\u4e00\u30a8\u30e9\u30fc\u30ec\u30b9\u30dd\u30f3\u30b9\n- \ud83d\udce6 **\u8efd\u91cf** - \u6a19\u6e96\u30e9\u30a4\u30d6\u30e9\u30ea\u306e\u307f\u3001\u5916\u90e8\u4f9d\u5b58\u306a\u3057\uff08\u8a8d\u8a3c\u6a5f\u80fd\u306f\u5225\u9014\uff09\n- \ud83d\udd12 **\u578b\u5b89\u5168** - \u5b8c\u5168\u306a\u578b\u30d2\u30f3\u30c8\u5bfe\u5fdc\n\n## \ud83d\ude80 \u30af\u30a4\u30c3\u30af\u30b9\u30bf\u30fc\u30c8\n\n### \u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\n\n```bash\n# \u57fa\u672c\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\npip install lambapi\n\n# \u30ed\u30fc\u30ab\u30eb\u958b\u767a\u74b0\u5883\uff08uvicorn \u4ed8\u304d\uff09\npip install lambapi[dev]\n\n# \u307e\u305f\u306f uvicorn \u3092\u500b\u5225\u306b\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\npip install lambapi uvicorn[standard]\n```\n\n### \u57fa\u672c\u7684\u306a\u4f7f\u7528\u4f8b\n\n```python\nfrom lambapi import API, create_lambda_handler, Query, Path, Body\nfrom dataclasses import dataclass\nfrom typing import Optional\n\n@dataclass\nclass CreateUserRequest:\n    name: str\n    email: str\n    age: Optional[int] = None\n\ndef create_app(event, context):\n    app = API(event, context)\n\n    @app.get(\"/\")\n    def hello():\n        return {\"message\": \"Hello, lambapi!\"}\n\n    @app.get(\"/search\")\n    def search(\n        query: str = Query(..., description=\"\u691c\u7d22\u30af\u30a8\u30ea\", min_length=1),\n        limit: int = Query(10, ge=1, le=100, description=\"\u7d50\u679c\u6570\"),\n        category: str = Query(\"all\", description=\"\u30ab\u30c6\u30b4\u30ea\u30fc\")\n    ):\n        return {\"query\": query, \"limit\": limit, \"category\": category}\n\n    @app.post(\"/users\")\n    def create_user(user_data: CreateUserRequest = Body(...)):\n        return {\n            \"message\": \"\u30e6\u30fc\u30b6\u30fc\u304c\u4f5c\u6210\u3055\u308c\u307e\u3057\u305f\",\n            \"user\": {\"name\": user_data.name, \"email\": user_data.email}\n        }\n\n    return app\n\nlambda_handler = create_lambda_handler(create_app)\n```\n\n### \u30ed\u30fc\u30ab\u30eb\u958b\u767a\n\nlambapi \u306f uvicorn \u3092\u4f7f\u7528\u3057\u305f\u9ad8\u6027\u80fd\u306a\u30ed\u30fc\u30ab\u30eb\u958b\u767a\u30b5\u30fc\u30d0\u30fc\u3092\u63d0\u4f9b\u3057\u307e\u3059\u3002AWS Lambda \u3068 API Gateway \u306e\u74b0\u5883\u3092\u5b8c\u5168\u306b\u518d\u73fe\u3057\u3001\u672c\u756a\u74b0\u5883\u3068\u540c\u7b49\u306e\u52d5\u4f5c\u3092\u4fdd\u8a3c\u3057\u307e\u3059\u3002\n\n```bash\n# \u65b0\u3057\u3044\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u3092\u4f5c\u6210\nlambapi create my-api --template basic\n\n# \u9ad8\u6027\u80fd\u30ed\u30fc\u30ab\u30eb\u30b5\u30fc\u30d0\u30fc\u3092\u8d77\u52d5\uff08uvicorn + \u30db\u30c3\u30c8\u30ea\u30ed\u30fc\u30c9\u4ed8\u304d\uff09\nlambapi serve app\n\n# \u30ab\u30b9\u30bf\u30e0\u30dd\u30fc\u30c8\u30fb\u30db\u30b9\u30c8\u8a2d\u5b9a\nlambapi serve app --host 0.0.0.0 --port 8080\n\n# \u8a73\u7d30\u30ed\u30b0\u3067\u30c7\u30d0\u30c3\u30b0\nlambapi serve app --debug --log-level debug\n\n# API \u52d5\u4f5c\u78ba\u8a8d\ncurl http://localhost:8000/\ncurl -X POST http://localhost:8000/users -H \"Content-Type: application/json\" -d '{\"name\":\"test\"}'\n```\n\n**uvicorn \u7d71\u5408\u306e\u5229\u70b9**:\n- \ud83d\ude80 **\u9ad8\u6027\u80fd** - \u975e\u540c\u671f ASGI \u30d9\u30fc\u30b9\u3067\u9ad8\u901f\u30ec\u30b9\u30dd\u30f3\u30b9\n- \ud83d\udd04 **\u30db\u30c3\u30c8\u30ea\u30ed\u30fc\u30c9** - \u30b3\u30fc\u30c9\u5909\u66f4\u3092\u5373\u5ea7\u306b\u53cd\u6620\n- \ud83c\udf10 **API Gateway \u4e92\u63db** - \u672c\u756a\u74b0\u5883\u3068\u540c\u7b49\u306e\u30ea\u30af\u30a8\u30b9\u30c8/\u30ec\u30b9\u30dd\u30f3\u30b9\u5f62\u5f0f\n- \ud83d\udcca **\u8a73\u7d30\u30ed\u30b0** - \u30ea\u30af\u30a8\u30b9\u30c8\u8a73\u7d30\u3068\u30a8\u30e9\u30fc\u60c5\u5831\u306e\u8868\u793a\n- \u2699\ufe0f **\u8c4a\u5bcc\u306a\u8a2d\u5b9a** - \u30ef\u30fc\u30ab\u30fc\u6570\u3001\u30ed\u30b0\u30ec\u30d9\u30eb\u7b49\u306e\u30ab\u30b9\u30bf\u30de\u30a4\u30ba\u53ef\u80fd\n\n## \ud83d\udcda \u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\n\n\u5b8c\u5168\u306a\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\u306f **[https://sskyh0208.github.io/lambapi/](https://sskyh0208.github.io/lambapi/)** \u3067\u516c\u958b\u3055\u308c\u3066\u3044\u307e\u3059\u3002\n\n<div class=\"grid cards\" markdown>\n\n-   \ud83d\ude80 **[\u30af\u30a4\u30c3\u30af\u30b9\u30bf\u30fc\u30c8](https://sskyh0208.github.io/lambapi/getting-started/quickstart/)**\n\n    5 \u5206\u3067\u6700\u521d\u306e API \u3092\u69cb\u7bc9\n\n-   \ud83d\udcd6 **[\u30c1\u30e5\u30fc\u30c8\u30ea\u30a2\u30eb](https://sskyh0208.github.io/lambapi/tutorial/basic-api/)**\n\n    \u5b9f\u969b\u306e\u30b3\u30fc\u30c9\u4f8b\u3067\u6a5f\u80fd\u3092\u5b66\u7fd2\n\n-   \ud83d\udd27 **[API \u30ea\u30d5\u30a1\u30ec\u30f3\u30b9](https://sskyh0208.github.io/lambapi/api/api/)**\n\n    \u3059\u3079\u3066\u306e\u30af\u30e9\u30b9\u3068\u30e1\u30bd\u30c3\u30c9\u306e\u8a73\u7d30\n\n-   \ud83c\udfd7\ufe0f **[\u30c7\u30d7\u30ed\u30a4\u30e1\u30f3\u30c8](https://sskyh0208.github.io/lambapi/guides/deployment/)**\n\n    \u672c\u756a\u74b0\u5883\u3067\u306e\u904b\u7528\u3068\u30d9\u30b9\u30c8\u30d7\u30e9\u30af\u30c6\u30a3\u30b9\n\n</div>\n\n## \ud83d\udca1 \u306a\u305c lambapi\uff1f\n\n### \u5f93\u6765\u306e\u554f\u984c\n\n```python\n# \u5f93\u6765\u306e Lambda \u30cf\u30f3\u30c9\u30e9\u30fc\uff08\u7169\u96d1\uff09\ndef lambda_handler(event, context):\n    method = event['httpMethod']\n    path = event['path']\n    query_params = event.get('queryStringParameters', {}) or {}\n    limit = int(query_params.get('limit', 10))  # \u624b\u52d5\u578b\u5909\u63db\n\n    if method == 'GET' and path == '/users':\n        # \u8907\u96d1\u306a\u30eb\u30fc\u30c6\u30a3\u30f3\u30b0...\n        pass\n\n    return {\n        'statusCode': 200,\n        'headers': {'Content-Type': 'application/json'},\n        'body': json.dumps({'data': 'result'})\n    }\n```\n\n### lambapi \u306a\u3089\n\n```python\n# lambapi \u7248\uff08\u30b7\u30f3\u30d7\u30eb\uff09\n@app.get(\"/users\")\ndef get_users(limit: int):\n    return {\"users\": [f\"user-{i}\" for i in range(limit)]}\n```\n\n\n\n## \ud83e\udd1d \u30b3\u30df\u30e5\u30cb\u30c6\u30a3\n\n- \ud83d\udcc1 **[GitHub](https://github.com/sskyh0208/lambapi)** - \u30bd\u30fc\u30b9\u30b3\u30fc\u30c9\u30fb Issues \u30fb Discussions\n- \ud83d\udce6 **[PyPI](https://pypi.org/project/lambapi/)** - \u30d1\u30c3\u30b1\u30fc\u30b8\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\n- \ud83d\udcda **[\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8](https://sskyh0208.github.io/lambapi/)** - \u5b8c\u5168\u306a\u4f7f\u7528\u30ac\u30a4\u30c9\n\n## \ud83d\udcc4 \u30e9\u30a4\u30bb\u30f3\u30b9\n\nMIT License - \u8a73\u7d30\u306f [LICENSE](LICENSE) \u30d5\u30a1\u30a4\u30eb\u3092\u53c2\u7167\n\n<!-- Generated by Claude \ud83e\udd16 -->\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "\u30e2\u30c0\u30f3\u306a AWS Lambda \u7528 API \u30d5\u30ec\u30fc\u30e0\u30ef\u30fc\u30af",
    "version": "0.2.3",
    "project_urls": {
        "Bug Tracker": "https://github.com/sskyh0208/lambapi/issues",
        "Documentation": "https://sskyh0208.github.io/lambapi/",
        "Homepage": "https://github.com/sskyh0208/lambapi",
        "Repository": "https://github.com/sskyh0208/lambapi"
    },
    "split_keywords": [
        "lambda",
        " api",
        " aws",
        " serverless",
        " http",
        " rest"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "95cc7d566c27727811687fef2a5d483c81c38b42fb64bf6456fba84a03cc9163",
                "md5": "bce81d206982b7a41140552d51a3c4ae",
                "sha256": "2c6fb9c19e6b4e5785521fd08d7137d004a2058a2c8bb5a31a5e675ced2f9b7f"
            },
            "downloads": -1,
            "filename": "lambapi-0.2.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bce81d206982b7a41140552d51a3c4ae",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 60373,
            "upload_time": "2025-08-11T05:25:58",
            "upload_time_iso_8601": "2025-08-11T05:25:58.565447Z",
            "url": "https://files.pythonhosted.org/packages/95/cc/7d566c27727811687fef2a5d483c81c38b42fb64bf6456fba84a03cc9163/lambapi-0.2.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2df21e90b8dd200a01dbbdbe0145faa6148b4d5a920e4cc3707c3da390c71211",
                "md5": "cff1c6538784e7cb5add8908880e7dbc",
                "sha256": "4a97ff47b3c65844654f10bb0023b02fa9e7a1b2d0a5825ea828275dabac9182"
            },
            "downloads": -1,
            "filename": "lambapi-0.2.3.tar.gz",
            "has_sig": false,
            "md5_digest": "cff1c6538784e7cb5add8908880e7dbc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 101604,
            "upload_time": "2025-08-11T05:26:00",
            "upload_time_iso_8601": "2025-08-11T05:26:00.018845Z",
            "url": "https://files.pythonhosted.org/packages/2d/f2/1e90b8dd200a01dbbdbe0145faa6148b4d5a920e4cc3707c3da390c71211/lambapi-0.2.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-11 05:26:00",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "sskyh0208",
    "github_project": "lambapi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lambapi"
}
        
Elapsed time: 2.16178s